目录
  • 1、安装
  • 2、生成swag文档
  • 3、在main上添加
  • 4、 引入docs文档
  • 5、创建swagger路由
  •  6、再接口上添加注释
  • 6、success 

1、安装

go install github.com/swaggo/swag/cmd/swag@latest
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/gin-swagger/swaggerFiles

2、生成swag文档

命令：swag init

错误
'swag' 不是内部或外部命令，也不是可运行的程序
或批处理文件。
 go install github.com/swaggo/swag/cmd/swag@latest

需要安装到bin环境变量

3、在main上添加

// @title Swagger Example API
// @version 1.0.0
// @description This is a sample Server pets
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name x-token
// @BasePath /
func main() {

4、 引入docs文档

golang使用swagger的过程详解

报错 Fetch error Internal Server Error doc.json 是没有引入docs

5、创建swagger路由

engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

golang使用swagger的过程详解

 6、再接口上添加注释

// @Tags CheckApi
// @Summary 检测测试
// @accept application/json
// @Produce application/json
// @Param data query request.Req true "查询渠道"
// @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
// @Router /router/addr [get]

golang使用swagger的过程详解

6、success 

golang使用swagger的过程详解

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。