Swag是一个用于自动生成API文档的工具，而Gin则是一个轻量级的Web框架。下面是如何将Swag与Gin集成的步骤：
- 安装Swag
使用以下命令安装Swag：
go get -u github.com/swaggo/swag/cmd/swag
- 初始化Swagger文档
在项目根目录下运行以下命令以初始化Swagger文档：
swag init
这将在项目根目录下创建一个docs文件夹，并生成swagger.json和swagger.yaml两个文件。
- 集成到Gin中
在main.go文件中引入gin-swagger包并注册路由：
import ("github.com/gin-gonic/gin"ginSwagger "github.com/swaggo/gin-swagger""github.com/swaggo/gin-swagger/swaggerFiles"_ "yourProject/docs" // 引入Swagger文档注释)func main() {r := gin.Default()// 注册Swagger路由r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))// 其他路由...}
- 编写Swagger注释
在需要生成API文档的代码段前添加注释，例如：
// @Summary 获取用户信息// @Description 获取指定id的用户信息// @Tags User// @Accept json// @Produce json// @Param id path int true "用户ID"// @Success 200 {object} ResponseUserInfo{}// @Failure 404 {object} ResponseError{}// @Router /user/{id} [get]func getUser(c *gin.Context) {// 实现获取用户信息的代码...}
- 生成API文档
重新运行swag init命令，即可在docs文件夹中生成更新后的Swagger文档。
- 访问Swagger UI界面
启动应用程序并访问http://localhost:8080/swagger/index.html即可看到自动生成的API文档界面。
![mysql_: [Warning] Using a password on the command line interface can be insecure. 使用mysql命令行连接反代postgresql读写分离的shardingsphere卡在这里](https://linuxcpp.0voice.com/zb_users/upload/2023/05/202305162232044214315.png)
