微服务架构（从无到有）二.客户端代码完善 2） gin+swagger 自动生成API接口文档

##使用 swagger 日志服务

go get -u github.com/swaggo/swag/cmd/swag
swag init  // 要和main.go处于同一级目录


编辑

initialize/router.go

引入包

swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"

在Routers := gin.Default()下面增加

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

swag init  // 要和main.go处于同一级目录

make tidy

swagger 书写格式

日常书写注释的格式

// @Summary 接口概要说明
// @Description 接口详细描述信息
// @Tags 用户信息   //swagger API分类标签, 同一个tag为一组
// @accept json  //浏览器可处理数据类型，浏览器默认发 Accept: */*
// @Produce  json  //设置返回数据的类型和编码
// @Param id path int true "ID"    //url参数：（name；参数类型[query(?id=),path(/123)]；数据类型；required；参数描述）
// @Param name query string false "name"
// @Success 200 {object} Res {"code":200,"data":null,"msg":""}  //成功返回的数据结构， 最后是示例
// @Failure 400 {object} Res {"code":200,"data":null,"msg":""}
// @Router /test/{id} [get]    //路由信息，一定要写上

项目启动后
可访问地址查看Api文档
http://127.0.0.1:18001/swagger/index.html#/

一个方式，但这么做会增加代码体量，具体看实际应用