swagger-API文档生成器

go install github.com/swaggo/swag/cmd/swag@latest 安装swagger命令
安装gin-swagger
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

import (
    "github.com/gin-gonic/gin"               //导入gin包
    ginSwagger "github.com/swaggo/gin-swagger"
    swaggerfiles "github.com/swaggo/files"
    _ "GinDemo/docs"
)

func main()  {
   r := gin.Default()
   r.GET("/doc/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
   r.Run(":8080")

}

@方法描述

在需要提供的API实现方法前加入下面的内容

// @Tags 公共方法
// @Summary 注册
// @Description 该接口用户实现用户注册
//Param参数：参数名，方法，类型，是否必填，提示
// @Param email query string true "邮箱"
// @Param password query string true "密码"
// @Param repassword query string true "重复密码"
// @Param name query string true "昵称"
// @Param code query string true "验证码"
// @Success 200 {string} json "{"msg":"true"}"
// @Router /user/register [post]

swag init 生成文档命令

此时运行gin已经可以通过/doc/index.html访问API文档

// @Consumes 传入类型：json，yaml，xml,txt,bin,urlform,multipartform
// @Produces 返回类型,同上