效率工具:前端和后端的接口文档工具统计和对比

下面介绍几种经常使用的接口文档工具:Rap二、ShowDoc、Swagger、Postman和Yapi。

自动生成接口文档工具-Swagger的使用,请戳连接juejin.im/post/5db930…json

工具对比

工具和特色api

Rap2数组

ShowDoc工具

Swaggerpost

查看接口的易用性测试

查看参数,比较直观接口

访问地址一个,可查看全部产品。文档

查看参数,比较直观部署

访问地址一个,可查看全部产品。get

参数不直观,有的数据类型不通用。

若是有10个项目,就有10个访问地址。

添加接口的快捷性

支持json导入

一、须要手动选择接口所在的标题-二级目录-三级目录

二、对多层数据不能支持(例如参数中有数组)

须要给每一个参数添加关键字

自动更新文档

不支持

不支持

支持

须要按照规范,添加代码注释,最后扫描生成文档

在线接口测试

支持

支持

支持


其余工具

还有Postman和Yapi。

Postman是客户端。接口共享,有人数限制。超过人数须要付费。

Yapi的平台网址yapi.demo.qunar.com。已开源,支持本地部署。


补充

Rap2的平台网址是http://rap2.taobao.org。已开源,支持本非部署。 

相关文章
相关标签/搜索