接口管理工具

因为公司的项目是前后端分离的.前端和后端经常需要对接接口.虽然我们项目有集成了SWAGGER,但是过程还是出现了很多问题.导致开发的效率太差.

  • 对于前端工程师,后端提供的接口文档,大多是不规范的,有使用 wiki 的,有 word 文档的,甚至还有用即时聊天软件沟通的,后端接口对于前端就像一个黑盒子,经常遇到问题是接口因未知原因增加参数了,参数名变了,参数被删除了.对于后端工程师,接口对接时总是需要写冗杂繁琐的文档,需要大量时间去维护接口文档。
  • 前端开发的功能在后端功能还没完成前,因为前端的功能依赖于后端的数据,导致工作无法顺利展开。为了解决这个问题,有些前端工程师在代码注入 json,还有后端工程师临时搭建一套测试数据服务器,这种情况下势必会影响工作效率和代码质量,也不能及时进行字段的更新。
  • 接口数据正确性无法得到保证。前端调用后端的接口数据渲染到 视图,数据一旦出错,将会导致视图和交互也出现问题,保证后端接口数据正确性变的愈来愈重要。接口自动化测试就是用来解决这个问题,但传统的接口测试框架使用成本很高,很多团队采用肉眼比对方式,效率很低。

特地去网上搜索一下大神们都是怎么解决的.然后找到了一大堆工具.

  • Rap
  • Nei
  • Easy-Mock
  • SWAGGER
  • YAPI
  • docLever

基本上都去注册试用了一下.总体感觉去哪儿网的YAPI用起来最舒服.其它的都比较麻烦.要嘛功能不全,要嘛就是数据不支持导入.或者就是用不来.
下面就copy一下Yapi的一些优点.

  • 共同维护一份接口定义,连接前后端 (基本功能)
  • 前端 Mock Server 方案 (基本功能)
  • 自动化测试 (加分项)
  • 支持数据导入导出(加分项)
  • 开源和易部署(加分项)

最后附上网址:
https://github.com/YMFE/yapi
https://yapi.ymfe.org