七叶笔记 » golang编程 » golang-echo框架实现swagger文档

golang-echo框架实现swagger文档

随着微服务的持续火热,越来越多的公司热衷于前后端分离,于是我们在日常的开发工作中,经常会出现需要开发接口和编写文档工作,需要前后端对接工作。还好swagger(丝袜哥)的横空出现,很好的帮我们解决了这个问题。

在这里,首先要说明一点,swagger很早就发布了。这里所写的是关于golang语言下的echo框架和swagger运用起来。

swagger是什么?

1、是一款让你更好的书写API文档的规范且完整框架。

2、提供描述、生产、消费和可视化RESTful Web Service。

3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。

首先在go-modules开发环境下新建一个项目。话不多说,直接上图。

然后要引用包

github.com/go-openapi/swag

 github.com/swaggo/echo-swagger  

可以用go get github.com/go-openapi/swag

或者把包地址直接写在上面,然后go build

路由或者main函数入口那里一定要引用一段代码

 e.GET("/swagger/*", echoSwagger.WrapHandler)  

我们运行起来看看效果

效果还是达到了我们的预期。在这里,开始思考了一个问题,引用了包github.com/swaggo/echo-swagger后,就可以实现我们想要的效果了,那是不是可以还有其他的swagger的引用,于是我进入github.com/swaggo网页,打开一看

果不其然啊,原生的swagger用的人并不多,gin的使用和点赞明显比echo要高啊。

源码地址:

下期:实现gin框架下的swagger的实现

相关文章