go语言gin框架中使用swagger

文章说明

• go version go1.17.1
• IDE:Goland
• module ginswagger
• 2022-08-13 by-zhangdi

下载依赖包

go get -u github.com/swaggo/swag/cmd/swag
go install github.com/swaggo/swag/cmd/swag
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

下载完成后 查看安装状态，看到如下图说明安装成功
swag -version

根目录下初始化swagger初始化命令示例
swag init,
初始化成功后会在项目与根目录下看到以下文件

开始使用

package main

import (
   "github.com/gin-gonic/gin"
   docs "github.com/go-project-name/docs"
   swaggerfiles "github.com/swaggo/files"
   ginSwagger "github.com/swaggo/gin-swagger"
   "net/http"
)

// @title           在gin中使用swagger -by zhandgi
// @version         1.0
// @description     This is a sample server celler server.
func main()  {
   r := gin.Default()
   docs.SwaggerInfo.BasePath = "/api/v1"
   v1 := r.Group("/api/v1")
   {
      eg := v1.Group("/example")
      {
         eg.GET("/helloworld",Helloworld)
      }
   }
   r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
   r.Run(":8080")

}

// Helloworld 示例doc
// @Summary 你好世界
// @Schemes
// @Description 这里是描述
// @Tags example
// @Accept json
// @Param id path int true "ID"
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context)  {
   g.JSON(http.StatusOK,"helloworld")
}

代码完成后在根目录下执行doc文档生成命令
swag init,

最后进入 http://localhost:8080/swagger/index.htm 即可看到swagger界面

ok,大功告成~