之前在公司用C# + ASP.Net Core开发Web API服务器中,用到Swagger这个插件来生成API文档觉得非常方便。
于是最近在学习golang开发Web API服务器的时候想着也集成Swagger到项目中,但是在网上找了很多文档都是不可行的,并且还很复杂,要么就是说一半的,写着写着不知道改怎么写了。
但是我不坑人,我接下来分享的我现在学习能够正常使用的方法,并且这篇博文我会在后面的使用过程中,有新的总结或者解决问题的方法都会更新出来。
这是要用到的github上的Swagger包链接,这是一个专门针对echo框架优化的。
1.go get 项目包
这个是API文档生成的工具
go get github.com/swaggo/swag/cmd/swag
这个是项目内导入的中间件包
go get -u github.com/swaggo/echo-swagger
先说下,这个swag工具download会自动编译生成可执行包到 GOPATH/bin 目录下,所以不需要我们去编译这个工具
2.生成API文档
控制台切换目录到work文件夹下,然后执行
swag init
检查控制输出没有报错,并且项目目录会多一个docs的文件夹