go gin swagger安装与使用

原文链接：https://blog.csdn.net/joychenwenyu/article/details/126935706

进入正题

1、首先在main函数前添加描述：

准备工作

引入swaggo依赖：

## swagger 依赖
go get "github.com/swaggo/files"
go get "github.com/swaggo/gin-swagger"


## swagger 命令行工具
go get -u github.com/swaggo/swag/cmd/swag
go install github.com/swaggo/swag/cmd/swag

 

进入正题

1、首先在main函数前添加描述：

// @title ginchat
// @version 1.0
// @description chenweihao test gonchat
// @termsOfService http://swagger.io/terms/

// @contact.name cwh
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host 127.0.0.1:8080
// @BasePath
func main() {
   utils.InitConfig()
   utils.InitMysql()
   r := router.Router()
   r.Run() // 监听并在 0.0.0.0:8080 上启动服务
}

2、注册swagger路由信息：

_ "ginchat/docs" 这个记得引入 不然会报错

import (
   _ "ginchat/docs"
   "ginchat/service"
   "github.com/gin-gonic/gin"
   swaggerFiles "github.com/swaggo/files"
   ginSwagger "github.com/swaggo/gin-swagger"
)

func Router() *gin.Engine {
   r := gin.Default()
   r.GET("/swagger/*any", func(c *gin.Context) {
      ginSwagger.DisablingWrapHandler(swaggerFiles.Handler, "SWAGGER")(c)
   })
   r.GET("/index/index", service.GetIndex)
   r.GET("/user/index", service.GetUserList)
   return r
}

3、 给函数方法添加备注：

// GetIndex
// @Tags 首页
// @Success 200 {string} welcome
// @Router /index/index [get]
func GetIndex(c *gin.Context) {
   c.JSON(200, gin.H{
      "message": "welcome",
   })
}

4、文档初始化
swag init 

项目结构
```
./helloworld
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
└── src
├──cmd
├── main.go
```

 

5、编译运行

编译运行服务，访问本地http://127.0.0.1:8080/swagger/index.html 即可访问swagger文档