go-zero 开发框架下通过插件生成 swagger 文档

更新日期：2021-1-16

 

安装 goctl-swagger

https://github.com/zeromicro/goctl-swagger

 

进入代码目录编译

***/pkg/mod/github.com/zeromicro/[email protected]#

go build -o goctl-swagger

把 goctl-swagger 复制到 /usr/bin

 

执行命令：

goctl api plugin -plugin goctl-swagger="swagger" -api app.api -dir .

后会生成文件：

rest.swagger.json

 

安装 go-swagger

https://github.com/go-swagger/go-swagger/releases

 

启动命令：

swagger serve -F=swagger swagger.json

我在 ubuntu 下启动失败。

在 win10 下测试时成功。执行的命令是：

swagger_windows_amd64.exe serve -F=swagger .\rest.swagger.json

注意一点，win10 下的 swagger_windows_amd64.exe 对 Model 对象的容错更好，不会启动 web 界面失败，但同样会慢。

如 json 中的对象有了指针 *object 就会报错。

win10 下只是在 web 界面报错。而 ubuntu 下启动失败在命令行报错。