API 文档、调试、Mock、测试一体化协作平台Apifox。

一、同类型产品对比

下面蓝色文案带有超链接，可点击。

产品类型	文档清晰度[重要]	接口调试	Mock数据	自动化测试	可用终端
Apifox	规范且清晰	支持很好	支持	支持	客户端、web页面
Swagger	3.0版还行	支持一般	支持	无	web页面
YApi	规范且清晰	支持一般	支持	无	web页面
语雀	看编写者	无	无	无	web页面
Postman	较弱	支持很好	支持	支持	客户端、web页面

二、部分功能展示

2.1、录入方式

支持Swagger、Postman等多种方式导入

Apifox对于文档手动录入也非常友好，把请求地址复制到文档中可以直接生成参数。

2.2、导出方式

支持html、markdown、pdf等格式

下面是markdown导出格式的演示

2.3、mock服务

非常棒的本地mock服务

1，mock环境与开发环境切换方便

2，mock数据随机生成。包括字符串，数组长度等。

3，直接拷贝mock地址即可使用

2.4、接口自动化测试

对于接口冒烟测试、接口稳定性测试、接口压力测试都非常nice

2.5、更多功能

参考Apifox 使用文档

三、Api文档选型推荐几点

api文档是前后端联调中非常重要的一环，个人觉得一下几点比较重要给大家推荐一下

3.1、文档清晰度

对于文档来说能看清楚非常重要，从这一点来讲，比较推荐apifox、yapi、语雀，这三个ui都非常整洁美观，友好的一批。

3.2、统一的规范

1，统一使用一种文档软件，且分好目录。

2，在接口变动时在前面加上tag，例如[询价2.0]web获取需求详情接口，[重构版]web获取需求详情接口

3.3、关于Apifox

Apifox并不是最好的，尝试可能会有一点成本，可能需要大家一起踩点坑，不想踩坑可以尝试yapi，也非常不错。