Swagger 相关的工具集会根据 OpenAPI 规范去生成各式各类的与接口相关联的内容,常见的流程是编写注解 =》调用生成库-》生成标准描述文件 =》生成/导入到对应的 Swagger 工具。
安装
因此接下来第一步,我们要先安装 Go 对应的开源 Swagger 相关联的库,在项目 blog-service 根目录下执行安装命令,如下:
$ go get -u github.com/swaggo/swag/cmd/swag
$ go get -u github.com/swaggo/gin-swagger
$ go get -u github.com/swaggo/files
$ go get -u github.com/alecthomas/template
验证是否安装成功,如下:
$ swag -v
swag version v1.6.5
此处有坑:go get
命令分两步:第一步如同git clone
拉取github上的依赖并下载,第二步就是会go install
编译,这个swagger包比较特殊,go install
编译会编译出可执行文件,然后放在GOBIN
。因此GOBIN的目录选择一定要选在可读可写权限目录下,如果你放在只读文件夹下,会安装不了swagger的可执行文件的!!!会报错:access denied
提醒权限不够
写入注解
在完成了 Swagger 关联库的安装后,我们需要针对项目里的 AP