Go——go web 集成swagger

swagger 完美API文档的生成工具，免去繁琐的面向wiki编程。java中可直接引用swagger依赖，spring全家桶对swagger也集成通过写注解便可直接生成入参返回值的api接口文档。go项目也有对应的swaggo集成。下面介绍如何在go工程中使用swaggo自动生成接口文档。很简单，三步走

一、项目download swaggo资源

//1.安装swag client

go get -u github.com/swaggo/swag/cmd/swag

# 2.gin-swagger 中间件

$ go get github.com/swaggo/gin-swagger

# 3.swagger 内置文件

$ go get github.com/swaggo/gin-swagger/swaggerFiles

二、go web工程集成swaggo

1. gin router 处添加如下代码（拦截器操作）

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

2.简单举例，更新接口api接口处添加注释，注意按如下注解编写注释

// @Summary 编辑系统用户

// @Description 编辑系统用户 账号、角色不予更新；只更新密码和姓名

// @Tags 系统用户模块

// @Param userName formData string true "账号"

// @Param password formData string false "密码"

// @Param realName formData string true "用户姓名"

// @Success 200 {string} json "{"msg": "添加成功"}"

// @Failure 401 {string} json "{"msg": "err.Error()"}"

// @Failure 402 {string} json "{"msg": "账号已存在"}"

// @Failure 403 {string} json "{"msg": "添加失败"}"

// @Router /user/update [post]

func (c UserController) Update(ctx *gin.Context) {

   //代码逻辑

}

注：注释格式可参照：使用swaggo自动生成Restful API文档

3. 同样在router中添加  import _ "rig-mini/docs" ，然后terminal执行swag init 命令，启动工程后访问http://localhost:12343/swagger/index.html即可查看api详情。

 三、访问swaggerUI页面看结果

 编写好注释的接口列表、uri、请求方式、接口parameter以及response ，一目了然，完美