根據指令1.16 or newer
go install github.com/swaggo/swag/cmd/swag@latest
....
確認下載工具成功
$ swag -v
swag version v1.8.6
可以查看對應指令
$ swag init --help swag init
cmd/app-core/docs/docs.go
cmd/app-core/docs/swagger.json
cmd/app-core/docs/swagger.yamlLast updated
import (
"github.com/gin-gonic/gin"
+ _ "github.com/minilabmemo/go-rest-arch/cmd/app-core/docs"
)
加入註解
+// @title Swagger Example API
+// @version 1.0
+// @description This is a sample server celler server.
func main() {
start := time.Now()
errs := make(chan error, 3)
listenForInterrupt(errs)
startup(errs)
defer stopMain()
zap.S().Infof("Service started in: %v", time.Since(start))
zap.S().Infof("Version %s", internal.Version)
c := <-errs
zap.S().Warnf("terminating: %v", c)
}
或者
import (
+ docs "github.com/minilabmemo/go-rest-arch/cmd/app-core/docs"
)
func main() {
+ docs.SwaggerInfo.Title = fmt.Sprintf("Swagger %s API", config.ConfigData.Service.Name)
}
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/filespackage apis
import (
"fmt"
"github.com/gin-gonic/gin"
"github.com/minilabmemo/go-rest-arch/internal/config"
+ swaggerfiles "github.com/swaggo/files"
+ ginSwagger "github.com/swaggo/gin-swagger"
"go.uber.org/zap"
)
func StartHttpServer(errChan chan error, engine *gin.Engine) {
+ engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
endpoint := fmt.Sprintf(":%d", config.ConfigData.Service.Port)
go func() {
errChan <- engine.Run(endpoint)
}()
zap.S().Infof("Listening on port: %d", config.ConfigData.Service.Port)
}
// @Summary Get info API
// @Schemes
// @Description Get info API
// @Tags infos
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /service/api/v1/info [get]
func (a *InfoHandler) GetInfo(c *gin.Context) {
//call usecase method
info, _ := a.CUsecase.GetInfo()
c.JSON(http.StatusOK, info)
}