swagger安装

安装swag

`go get github.com/swaggo/swag/cmd/swag`

验证

`swag -v`

安装依赖包

`go get -u github.com/swaggo/gin-swagger`

`go get github.com/swaggo/files或swaggerFiles `

注解

@Tags 用户接口
@Summary      操作的简短摘要
@Param name query string true "用户姓名"
1.参数名
2.参数类型，可以有的值是 formData、query、path、body、header，formData 表示是 post 请求的数据，query 表示带在 url 之后的参数，path 表示请求路径上得参数，例如上面例子里面的 key，body 表示是一个 raw 数据请求，header 表示带在 header 信息中得参数。
3.参数类型
4.是否必须
5.注释	

示例

• main.go(路由)

  	package main
    import (
     "github.com/gin-gonic/gin"
     gs"github.com/swaggo/gin-swagger"
     "github.com/swaggo/gin-swagger/swaggerFiles"
     "talentchain/controller"
     _ "talentchain/docs"
    )

    func main() {
        r := gin.Default()
        // 添加swagger访问路由
        r.GET("/swagger/*any", gs.WrapHandler(swaggerFiles.Handler))
        r.POST("/register",controller.Register)
        r.Run(":8000")
    }

生成文档(会生成一个docs文件夹)

./docs
├── docs.go
├── swagger.json
└── swagger.yaml

`swag init`

访问

`http://127.0.0.1:8000/swagger/index.html`

注

• 快速上手文档 swag使用
• 官方文档swagger详细使用指南