API接口管理,8 款在线 API 接口文档管理工具;好用!

Oden 5117 2022-07-12


1、Postman
Postman是被大家所熟知的网页调试Chrome插件,我们常常用它来进行临时的http请求调试。幸运的是,Postman可以将调试过的请求保存到Collection中。形成的Collection就可以作为一份简单有效且支持在线测试的接口文档,使用同一账号登录就可以做到分享和同步。对QA来说,使用Postman进行接口测试和接口文档维护是同一件事情,测试即文档,维护成本也很低。官网:https://www.getpostman.com

2、Swagger
“Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。”简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案。Swagger主要包含了以下4个部分:
1. Swagger可以直接嵌入项目中,通过开发时编写注释,自动生成接口文档;
2. Swagger包含了Swagger Editor,它是使用yaml语言的Swagger API的编辑器,支持导出yaml和json格式的接口文件;
3. Swagger包含了Swagger UI,它将Swagger Editor编辑好的接口文档以html的形式展示出来;
4. Swagger支持根据定义的接口导出各种语言的服务端或客户端代码。
官网:https://swagger.io/

3、RAP2
RAP来自阿里巴巴,是一个可视化接口管理工具 通过分析接口结构,使用mock动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率。可以在线使用,也可以选择本地部署。一个GUI的WEB接口管理工具。在RAP中,您可定义接口的URL、请求&响应细节格式等等。通过分析这些数据,RAP提供MOCK服务、测试服务等自动化工具。RAP同时提供大量企业级功能,帮助企业和团队高效的工作。官网:http://rapapi.org/platform/home.do

4、YApi
YApi是由去哪网前端团队开源的一款接口管理工具,功能强大,可以轻松的自己部署。而且支持使用docker部署,使用成本很低了。官网:https://yapi.ymfe.org

5、Eolinker
eolinker是一个接口管理服务网站,如果不想自己部署YApi、Rap2、Swagger等的团队可以使用,免费版的功能对于小型团队来说足够了。官网:https://www.eolinker.com

6、DOClever
可以对接口信息进行编辑管理,支持 get,post,put,delete,patch 五种方法,支持 https 和 https 协议,并且支持 query,body,json,raw,rest,formdata 的参数可视化编辑。同时对 json 可以进行无限层次可视化编辑。并且,状态码,代码注入,markdown 文档等附加功能应有尽有。接口调试运行,可以对参数进行加密,从 md5 到 aes 一应俱全,返回参数与模型实时分析对比,给出不一致的地方,找出接口可能出现的问题。如果你不想手写文档,那么试试接口的数据生成功能,可以对接口运行的数据一键生成文档信息。mock 的无缝整合,DOClever 自己就是一个 mock 服务器,当你把接口的开发状态设置成已完成,本地 mock 便会自动请求真实接口数据,否则返回事先定义好的 mock 数据。支持 postman,rap,swagger 的导入,方便你做无缝迁移,同时也支持 html 文件的导出,方便你离线浏览!项目版本和接口快照功能并行,你可以为一个项目定义 1.0,1.1,1.2 版本,并且可以自由的在不同版本间切换回滚,再也不怕接口信息的遗失,同时接口也有快照功能,当你接口开发到一半或者接口需求变更的时候,可以随时查看之前编辑的接口信息。自动化测试功能,目前市面上类似平台的接口自动化测试大部分都是伪自动化,对于一个复杂的场景,比如获取验证码,登陆,获取订单列表,获取某个特定订单详情这样一个上下文关联的一系列操作无能为力。而 DOClever 独创的自动化测试功能,只需要你编写极少量的 javascript 代码便可以在网页里完成这样一系列操作,同时,DOClever 还提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能,你可以及时获取接口的运行状态。团队协作功能,很多类似的平台这样的功能是收费的,但是 DOClever 觉得好东西需要共享出来,你可以新建一个团队,并且把团队内的成员都拉进来,给他们分组,给他们分配相关的项目以及权限,发布团队公告等等。官网: http://doclever.cn

7、CrapApi
CrapApi接口管理系统实际上是一个java开源项目。一个由anjularjs+bootstrap+springMVC搭建的免费开源的API接口管理系统(应用接口管理系统)后台开发语言为java,主要技术:anjularjs、bootstrap、springMVC、hibernate、maven Application Programming Interface。演示地址:http://api.crap.cn 或http://api2.crap.cn  账号:super 123456 。系统特点: 系统支持管理员管理、权限控制、角色管理 支持多项目、多模块划分,同时支持私密项目、模块密码访问 支持数据字典管理、支持数据字典密码访问 支持项目错误码管理、支持接口拷贝等功能 支持前端菜单自定义,支持管理员菜单自定义。官网:https://github.com/EhsanTang/CrapApi

8、EasyAPI
接口文档相对简单,不过对于那些喜欢简单接口文档的朋友来说,easyAPI 也不失为一个不错的选择,界面简单明了,配色粉蓝粉蓝很可爱,不过在我试用的过程中,界面好像不是很稳定,有些按钮点击时没有反应,图标时可见时不可见。而且因为接口文档和接口测试不是在一个菜单之下的,两个功能之间的转换有些费力。同时也有回收站,版本管理等功能,总的来说,就是比 eolinker 简单,比 rap 好看。不过接口测试的功能还是挺强大的,左边填数据,右边显示结果,感觉还是挺直观的,如果能支持本地测试就更好啦。官网:https://www.easyapi.com/

9、Apizza
1.项目管理;2.api分类管理;3.自动保存request 和 response,这个可以为以后自动化测试做准备;4.跨域模拟请求5.自动生成文档这个功能很好用,可以直接把参数分析成文档。最后导出成html文档。官网:http://apizza.cc


8 款在线 API 接口文档管理工具;好用!

大家好,我是一航;

后端程序员写接口文档,是一项永远逃不掉的任务;前段时间,给大家推荐了ApiPost:《是时候丢掉 Postman、Swagger 了;这个工具全部搞定,真香!》,看群里面的小伙伴儿用了之后反馈都说挺好用的;那么趁热打铁,一起整理了8款在线文档管理工具,相信总有一款能合你的胃口;

目录

  1. RAP

  2. Eolink

  3. EasyAPI

  4. Apizza

  5. EasyDoc

  6. ShowDoc

  7. ApiFox

  8. ApiPost

1. RAP

地址:http://rap2.taobao.org/  (免费,支持私有化)

支持版本管理,开源,有文档;在老东家的时候,就是本地部署了一个私有化的RAP,文档风格非常的简洁,同时支持项目管理,团队管理;有一套完整的成员权限管理方案。

地址:https://www.eolinker.com

一站式 API 生产力工具;

结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 生产平台,从个人开发者到跨国企业用户,Eolink 帮助全球超过30万开发者和数万家企业更快、更好且更安全地开发和使用 APl。

  • API 文档与研发管理

  • API 快速测试与自动化测试

  • API 监控和异常告警

  • API 微服务网关

  • API 快速生成与开放交易

3. EasyAPI

地址:https://www.easyapi.com/

EasyAPI是一个为您提供API管理、API测试、API监控、API文档的综合性API服务平台。

4. Apizza

地址:https://apizza.net

极客专属的接口协作管理工具

5.EasyDoc(易文档)

地址:https://easydoc.net/

6. ShowDoc

地址:https://www.showdoc.cc/

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

7.ApiFox

https://www.apifox.cn

ApiFox是一款API 文档、API 调试、API Mock、API 自动化测试工具,这个工具主要是以客户端为主,不仅能高效测试,还能快速生成在线的API文档。

8.ApiPost

https://www.apipost.cn/

ApiPost不仅可以快速生成接口文档,还支持导出离线html、markdown、word文档。方便您部署接口文档到您的本地甚至局域网服务器



版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:文案君:动画师放假了?没上色都能发布?!
下一篇:DoMarketing-营销智库:优秀策划人应该具有的17个习惯!
相关文章

 发表评论

评论列表

2022-11-09 15:16:47

感谢作者分享的这几个API接口管理工具,先收藏起来

2022-11-09 15:17:20

我们团队现在用的是eolink,我觉得还是不错的

2022-11-10 13:21:35

API 接口文档管理工具原来还是有挺多的,看着还不错,选适合自己团队的就好

2022-11-10 13:22:41

最近听的比较多的是eolink的,好像知名度还是挺高的

2022-11-14 17:51:54

用过几个接口管理工具,都还可以,其实eolink也不错。非水军,就是刚好刷到发现了eolink的文章进来看看