[go-swagger]在go语言中使用swagger教程

import(
   swaggerFiles "github.com/swaggo/files"
   ginSwagger "github.com/swaggo/gin-swagger"
   _ "yoloblog1.0/docs"       //之前使用swag init 生成的swagger文档的路径
)

2、在具体的路由处理函数上方添加注释，定义该接口的行为。

// Register
// @Summary 用户注册

//@Tags User

// @Produce json
// @Param user body system.SysUser true "用户信息"
// @Success 200 {object} system.SysUser
// @Failure 400 {string} string "注册失败"
// @Router /user/register [post]
func (m *UserApi) Register(c *gin.Context) {
   var user system.SysUser
   c.ShouldBindJSON(&user)
   err := userService.Register(&user)
   if err != nil {
       c.JSON(http.StatusOK, gin.H{
           "status": global.FAIL,
           "msg": err.Error(),
       })
       return
   }
   c.JSON(http.StatusOK, gin.H{
       "status": global.SUCCESS,
       "msg": "success",
   })
   return
}

@Summary：接口简述
@Produce：返回的 MIME 类型
@Param：参数定义（格式：名称位置类型是否必填描述）
@Success：成功响应（格式：状态码 {类型} 数据结构描述）
@Failure：失败响应
@Router：路由路径和方法
@Tags:给swagger进行分组

3、在gin路由中声明swagger的接口

func main() {
   global.Router = gin.Default()
   global.Router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
   global.Router.Run(":8080")
}

4、重新初始化swagger

swag init

4、实现结果

访问swagger链接

http://127.0.0.1:8080/swagger/index.html

5、在swagger中设置Authorization实现jwt校验

1、在Swagger配置前面添加上一段安全定义

// @title Your API Title
// @version 1.0
// @description Your API description
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @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

// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name Authorization

func main() {
   global.Router = gin.Default()

   utils.Connmysql()
   initialize.RunServer()
   //程序结束之前，关闭服务器链接
   db, _ := global.Db.DB()
   defer db.Close()
   global.Router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
   global.Router.Run(":8080")
}

2、在API处理函数的注释中，使用@Security标签来指定需要使用JWT校验

// @Summary 获取用户信息
// @Description 获取用户详细信息
// @Tags user
// @Accept json
// @Produce json
// @Success 200 {object} User
// @Router /user [get]
// @Security ApiKeyAuth
func GetUser(c *gin.Context) {
// 实现获取用户信息的逻辑
}