Swagger

---

Fiber용 Swagger 미들웨어입니다. 이 미들웨어는 Swagger UI를 처리합니다.

참고: Go 1.18 이상 버전이 필요합니다

Table of Contents

• Signatures

• Installation

• Examples

• Config

• Default Config

Signatures

func New(config ...swagger.Config) fiber.Handler

Installation

Swagger는 모듈 지원과 함께 최신 Go 버전에서 테스트됩니다. 그러니 아직 하지 않았다면 먼저 초기화해야 합니다:

go mod init github.com/<user>/<repo>

그런 다음 swagger 미들웨어를 설치합니다:

go get github.com/gofiber/contrib/swagger

Examples

미들웨어 패키지를 임포트합니다

import (
  "github.com/gofiber/fiber/v2"
  "github.com/gofiber/contrib/swagger"
)

기본 설정 사용:

app.Use(swagger.New())

커스텀 설정 사용:

cfg := swagger.Config{
  BasePath: "/",
  FilePath: "./docs/swagger.json",
  Path: "swagger",
  Title: "Swagger API Docs",
}
app.Use(swagger.New(cfg))

여러 Swagger 인스턴스 사용:

// v1용 Swagger 미들웨어 생성
//
// Swagger는 /api/v1/docs에서 사용 가능합니다
app.Use(swagger.New(swagger.Config{
  BasePath: "/api/v1/",
  FilePath: "./docs/v1/swagger.json",
  Path: "docs",
})) 

// v2용 Swagger 미들웨어 생성
//
// Swagger는 /api/v2/docs에서 사용 가능합니다
app.Use(swagger.New(swagger.Config{
  BasePath: "/api/v2/",
  FilePath: "./docs/v2/swagger.json",
  Path: "docs",  
}))

Config

type Config struct {
  // Next는 true를 반환하면 이 미들웨어를 건너뛰는 함수를 정의합니다. 
  //
  // 선택 사항. 기본값: nil
  Next func(c *fiber.Ctx) bool

  // UI path의 BasePath
  // 
  // 선택 사항. 기본값: / 
  BasePath string

  // swagger.json 또는 swagger.yaml 파일의 FilePath
  //
  // 선택 사항. 기본값: ./swagger.json
  FilePath string 

  // Path는 전체 UI path를 위해 BasePath와 결합됩니다
  //
  // 선택 사항. 기본값: docs
  Path string

  // 문서 사이트의 Title 
  //
  // 선택 사항. 기본값: Fiber API documentation
  Title string

  // CacheAge는 Cache-Control 헤더의 max-age를 초 단위로 정의합니다.
  //
  // 선택 사항. 기본값: 3600 (1시간)
  CacheAge int
}

Default Config

var ConfigDefault = Config{
  Next: nil,
  BasePath: "/",
  FilePath: "./swagger.json",
  Path: "docs",
  Title: "Fiber API documentation",
  CacheAge: 3600, // 기본값 1시간
}