3.8 为它加上Swagger

涉及知识点

    Swagger

本文目标

一个好的 API's,必然离不开一个好的API文档,如果要开发纯手写 API 文档,不存在的(很难持续维护),因此我们要自动生成接口文档。

安装 swag

1
$ go get -u github.com/swaggo/swag/cmd/swag
Copied!
$GOROOT/bin 没有加入$PATH中,你需要执行将其可执行文件移动到$GOBIN
1
mv $GOPATH/bin/swag /usr/local/go/bin
Copied!

验证是否安装成功

检查 $GOBIN 下是否有 swag 文件,如下:
1
$ swag -v
2
swag version v1.1.1
Copied!

安装 gin-swagger

1
$ go get -u github.com/swaggo/gin-swagger
2
3
$ go get -u github.com/swaggo/gin-swagger/swaggerFiles
Copied!
注:三个包都有一定大小,安装需要等一会或要科学上网。

初始化

编写API注释

Swagger 中需要将相应的注释或注解编写到方法上,再利用生成器自动生成说明文件
gin-swagger 给出的范例:
1
// @Summary Add a new pet to the store
2
// @Description get string by ID
3
// @Accept json
4
// @Produce json
5
// @Param some_id path int true "Some ID"
6
// @Success 200 {string} string "ok"
7
// @Failure 400 {object} web.APIError "We need ID!!"
8
// @Failure 404 {object} web.APIError "Can not find ID"
9
// @Router /testapi/get-string-by-int/{some_id} [get]
Copied!
我们可以参照 Swagger 的注解规范和范例去编写
1
// @Summary 新增文章标签
2
// @Produce json
3
// @Param name query string true "Name"
4
// @Param state query int false "State"
5
// @Param created_by query int false "CreatedBy"
6
// @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}"
7
// @Router /api/v1/tags [post]
8
func AddTag(c *gin.Context) {
Copied!
1
// @Summary 修改文章标签
2
// @Produce json
3
// @Param id path int true "ID"
4
// @Param name query string true "ID"
5
// @Param state query int false "State"
6
// @Param modified_by query string true "ModifiedBy"
7
// @Success 200 {string} json "{"code":200,"data":{},"msg":"ok"}"
8
// @Router /api/v1/tags/{id} [put]
9
func EditTag(c *gin.Context) {
Copied!
参考的注解请参见 go-gin-example。以确保获取最新的 swag 语法

路由

在完成了注解的编写后,我们需要针对 swagger 新增初始化动作和对应的路由规则,才可以使用。打开 routers/router.go 文件,新增内容如下:
1
package routers
2
3
import (
4
...
5
6
_ "github.com/EDDYCJY/go-gin-example/docs"
7
8
...
9
)
10
11
// InitRouter initialize routing information
12
func InitRouter() *gin.Engine {
13
...
14
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
15
...
16
apiv1 := r.Group("/api/v1")
17
apiv1.Use(jwt.JWT())
18
{
19
...
20
}
21
22
return r
23
}
Copied!

生成

我们进入到gin-blog的项目根目录中,执行初始化命令
1
[$ gin-blog]# swag init
2
2018/03/13 23:32:10 Generate swagger docs....
3
2018/03/13 23:32:10 Generate general API Info
4
2018/03/13 23:32:10 create docs.go at docs/docs.go
Copied!
完毕后会在项目根目录下生成docs
1
docs/
2
├── docs.go
3
└── swagger
4
├── swagger.json
5
└── swagger.yaml
Copied!
我们可以检查 docs.go 文件中的 doc 变量,详细记载中我们文件中所编写的注解和说明

验证

大功告成,访问一下 http://127.0.0.1:8000/swagger/index.html, 查看 API 文档生成是否正确
image

参考

本系列示例代码

关于

修改记录

    第一版:2018年02月16日发布文章
    第二版:2019年10月01日修改文章

如果有任何疑问或错误,欢迎在 issues 进行提问或给予修正意见,如果喜欢或对你有所帮助,欢迎 Star,对作者是一种鼓励和推进。

我的公众号

image
Last modified 2yr ago