下面介绍几种常用的接口文档工具：Rap2、ShowDoc、Swagger、Postman和Yapi。
自动生成接口文档工具-Swagger的使用，请戳链接juejin.cn/post/684490…
工具对比
工具和特点 | Rap2 | ShowDoc | Swagger |
查看接口的易用性 | 查看参数，比较直观 访问地址一个，可查看所有产品。 | 查看参数，比较直观 访问地址一个，可查看所有产品。 | 参数不直观，有的数据类型不通用。 如果有10个项目，就有10个访问地址。 |
添加接口的快捷性 | 支持json导入 | 1、需要手动选择接口所在的标题-二级目录-三级目录 2、对多层数据不能支持（例如参数中有数组） | 需要给每个参数添加关键字 |
自动更新文档 | 不支持
| 不支持
| 支持 需要按照规范，添加代码注释，最后扫描生成文档 |
在线接口测试 | 支持 | 支持 | 支持 |
其他工具
还有Postman和Yapi。
Postman是客户端。接口共享，有人数限制。超过人数需要付费。
Yapi的平台网址yapi.demo.qunar.com。已开源，支持本地部署。
补充
Rap2的平台网址是rap2.taobao.org。已开源，支持本非部署。
