一 背景
我们的接口文档现在主要是swagger接口,但是太过分散,且经过网关转换之后,有一定的变化,而此开源整好可以解决我们的痛点:
主要的几个痛点:
1 接口太分散,前端同学找我们后端的swagger接口比较麻烦
2 swagger接口文档不太清晰,而且要层层展开才能看到里面的注释,不熟悉swagger的前端同学都需要去解释注释在哪里。
所以萌生了找一个开源的想法,但是经过一番查找,是找到了,但也无法满足我们的需要,并且有很多的bug,那么就在此基础上去优化调整。直至满足了我们的要求,并且还可以不断去迭代优化。
该接口管理工具的特点
1 兼容后端的swagger接口文档,直接配置服务地址即可
2 可在某个服务直接搜索对应的接口,方便快捷
3 请求入参说明和是否必填等都非常清晰
4 支持在线调试,且支持通过网关的接口地址调试
二 该开源的地址
维护在github上
https://github.com/mafgwo/swagger-manage
可自行上去拉取下来,如果需要还可以自行调整,当然如果发现一些问题可以提issue,作者会去不断优化。
三 一些截图
界面如截图: