使用指南

1. 需要在代码中添加特定注释

   • 注释加在controller文件中

     注释	描述	示例
     @Summary	API的简介	@Summary 添加好友
     @Produce	API产生的内容类型	@Produce json
     @Param	API的参数	@Param uid body int true "好友uid"
     @Success	API成功的响应	@Success 200 {object} resp.ResponseData "成功"
     @Failure	API失败的响应	@Failure 500 {object} resp.ResponseData "内部错误"
     @Router	API的路由	@Router /api/user/add [post]

2. 安装go get -u github.com/swaggo/swag/cmd/swag和go install github.com/swaggo/swag/cmd/swag@latest

3. swag init

   1. 在和main.go同一个目录下运行
   2. 这个命令会自动建立docs文件夹，并自动生成docs.go swagger.json两个文件

4. 在项目路由添加

   //添加swagger访问路由
   router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

   • *any通配符，表示访问任何都会跳转到swagger页面

5. 项目跑起来之后

   • 访问http://localhost:8080/swagger/index.html即可查看接口文档

参考资料

• swag/README_zh-CN.md at master · swaggo/swag (github.com)