Golang开发Web API服务器,echo框架集成Swagger快速开发API文档

之前在公司用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的文件夹

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值