一、目的

方便前后端分离开发,同时兼顾文档功能,具备独立部署或者数据导出功能,方便后续维护升级。基于这几个原则,主要考虑以下几个因素:

  • 接口测试
  • Mock
  • 团队协作
  • 文档编写
  • 版本管理
  • 独立部署

二、备选

功能 \ api 管理系统 Swagger RAP2 Postman sosoAPI eoLinker
文档功能
接口测试 --
Mock数据 -- --
版本管理 -- -- -- --
团队协作 -- --
用户体验
独立部署 -- --
第三方api -- -- -- --

总结及点评:

  • Swagger:适用于简单的api接口文档记录,但是文档书写比较费劲。及其简洁,非常流行。但是文档书写比较费劲。
  • RAP2:适用于团队协作接口管理,但是跟文档结合不够好。RAP1的体验非常差,RAP2有非常大的改进。
  • Postman:测试就是文档,文档就是测试。适用于接口的开发测试及文档记录
  • SosoAPI:编辑Swagger UI的神器,文档功能集成了Swagger,简化了书写成本,
  • eoLinker:目前最佳,将文档、管理、测试、Mock结合在一起。还有第三方api商店,简洁强大。
  • Restlet Client (DHC):chrome 插件,模拟restful接口请求,收费产品。
  • showdoc:免费,使用markdown,通过表格方式记载api信息。超简洁。
  • apizza

三、选型

eolinker 是目前最佳,将文档、管理、测试、Mock结合在一起,满足了我们对api选型的全部要求。还有第三方api商店,简洁强大。目前阶段可以使用eolinker在线版本,后续根据情况购买专业版以及考虑自己部署开源版本。

一些资源链接如下:

参考文档