在项目开发测试中,接口文档是贯穿始终的。前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试。接口文档往往以最简单的静态文档的形态存在。然而在紧张的敏捷开发模式下,随着版本迭代,很多接口发生了变化或者被废弃,而开发几乎不会在后期去更新这种静态文档。QA人员阅读“过期”的接口文档是一件痛苦的事情,与开发的沟通成本不降反升、而这些不便于及时维护的静态文档,随着时间的推移最终无人问津。因此我们想找到一种长期可维护且轻量便捷的接口文档工具。下面介绍几种接口文档工具:
这是在所有接口管理平台中我觉得功能做最好的一个了,功能齐全,完全开源免费,支持内网部署!可根据接口的业务场景进行自动化测试、支持项目和团队两种协作模式、可根据项目的迭代在不同的版本间进行切换和回滚、mock 的无缝整合,让你前后端的协作行云流水、可以对接口信息进行编辑管理、在线接口文档,支持 https 和 https 协议等;
这是在所有接口管理平台中我觉界面做的最好的,基本上功能相对来说比较齐全,项目管理到接口管理,支持团队协作,接口测试,版本管理,在线分享,导入导出等
RAP 算是比较早做接口管理这块了(好像是阿里的一个团队开发的),不过接口管理的功能上来说就有一些逊色了,文档信息不够详细,团队协作那块第一次用的时候我真的是完全懵逼了,而且界面真的是有些简陋(感觉像是后台开发人员写的界面),不过接口管理的基本功能都有,支持版本管理,mock 测试,导入导出,而且是开源的,文档也比较详细,大家有时间的话可以以此为基础开发自己想要的功能咯。
接口文档相对简单,不过对于那些喜欢简单接口文档的朋友来说,easyAPI 也不失为一个不错的选择,界面简单明了,配色粉蓝粉蓝很可爱,不过在我试用的过程中,界面好像不是很稳定,有些按钮点击时没有反应,图标时可见时不可见。而且因为接口文档和接口测试不是在一个菜单之下的,两个功能之间的转换有些费力。同时也有回收站,版本管理等功能,总的来说,就是比 eolinker 简单,比 rap 好看。
不过接口测试的功能还是挺强大的,左边填数据,右边显示结果,感觉还是挺直观的,如果能支持本地测试就更好啦。
用过 DHC 的朋友应该会觉得 apizza 的界面似曾相识,用户在编辑接口的同时也可以进行接口测试,很方便也很简单,如果只是想使用接口管理平台进行接口管理和接口测试的朋友,apizza 不失为一个不错的选择,功能虽不强大,但十分轻巧简单,对于用惯 DHC 但英文又差的我而言,第一次看到这个简直眼前一亮啊有木有。
其他管理工具
1.Swagger:
通过固定格式的注释生成文档. 省时省力,不过有点学习成本。
网址:https://swagger.io/
2.Showdoc:
一个非常适合IT团队的在线API文档、技术文档工具。
网址:https://www.showdoc.cc/
3.apidoc:
可以根据代码注释生成web api文档,web接口的注释维护起来更加方便,不需要额外再维护一份文档。
网址:http://apidocjs.com/
4.APIJSON:
客户端可以定义任何JSON结构去向服务端发起请求,服务端就会返回对应结构的JSON字符串,所求即所得。
网址:http://jsonapi.org/
5.小幺鸡