Apifox使用文档

简介

Apifox是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，更先进的 API 设计/开发/测试工具，定位 Postman + Swagger + Mock + JMeter。

使用方式

Apifox有网页版和安装版，需要提前使用手机号或者微信登录。

• 网页版

访问网页 https://app.apifox.com/user/login，登录后即可使用。

• 安装版

访问 https://apifox.com/ 下载指定版本，安装完成后，注册/登录。

基础用法

创建团队、项目

通过创建团队和项目来分类项目：

项目中使用文件夹对接口分类：

创建接口

左侧导航栏点击新建接口后，分别有四个tab，

【文档】

【修改文档】

输入接口路径，接口名称，接口类型，接口入参，接口响应数据

接口路径：可以输入完整的ip:端口号/接口路径，也可以只输入接口路径，结合右上角的开发环境来切换ip和端口

例如：server代码可以统一配置如下，调用接口时，选择环境指定环境即可。

接口入参：入参可以手动新增，也可以自动创建；

【推荐】手动新增方式1：直接通过json数据生成，将请求参数复制下述位置，即可自动生成请求字段，然后自行配置字段是否必填；

手动新增方式2：手动添加每个请求字段，设置字段类型，字段是否必填；

使用手动新增方式2添加的字段，如果有使用到对象类型，可以创建对象模型，其他接口可直接引用：

注意：get请求，将带有参数的请求直接复制到接口路径后，会自动生成入参至Params中；

post请求：注意是RequestBody格式还是RequestParam格式，RequestBody参数放在【Body】中，使用json格式，RequestParam参数放在【Params】，文件上传等特殊格式，参数放在【Body】中

接口创建成功后保存，即可到【运行界面】进行调试，如果接口有填默认的入参，首次运行会填充默认参数，可以自行修改。

同样，运行后的入参和返回数据，也可以复制到【文档页面】入参和返回数据的实例中，作为接口文档输出；或者可以保存为用例，方便下次直接运行。

运行接口

【运行界面】，点击发送，等待结果响应后，可以将入参、响应结果保存到文档中，后续导出接口即可输出到文档中：

或者保存为用例。

idea插件

Apifox Helper 是 Apifox 团队针对 IntelliJ IDEA 环境所推出的插件，可以在 IDEA 环境中识别本地 Java、Kotlin 后端项目的源代码，自动生成 API 文档并一键同步到 Apifox 的项目中。

1、安装插件

在IDEA的插件市场搜索 Apifox Helper，安装。（插件支持 IntelliJ IDEA 2019.3 及更高的版本。）

2、Apifox配置

配置apifox之前，需要注册apifox账号，登录账号后，点击右上角的【账号设置】，

添加API访问令牌，设置有效期。

3、IDEA配置

在对应项目的IDEA设置中，输入步骤2的API访问令牌，点击测试，成功后，可配置代码模块和Apifox项目的对应关系，即指定项目的接口可以上传到对应Apifox项目中。

3、接口同步

支持同步以下范围内的接口：

• 模块内的全部接口：在左侧目录树的模块节点，点击右键，选择「Upload to Apifox」

• Controller 内的全部接口：在 Controller 文件内部，点击右键，选择「Upload to Apifox」

例如：同步manage模块的OrderStatusController【单据状态】的接口，如下图所示：

点击上传后，控制台会返回结果，Created是新建成功的接口个数，Updated是更新成功的接口个数

打开Apifox的对应项目，已生成对应接口：

【注】老版本的Apifox Helper是通过项目ID的形式对应后端接口和Apifox项目的，可参考下图：

Apifox的项目ID：

IDEA配置项目ID：

【注意事项】

• IDEA导出接口后，若Apifox没有更新，可点击右上角的刷新按钮

• 导出的字段，是否必填，需要手动确认下，可能后端字段没有配置相应注解

• 导出的字段会自动绑定到相关对象模型，如果需要自定义修改字段内容，可以解除关联后，再修改；

如果需要修改对象模型注释等内容，在导航栏左侧的数据模型中修改即可：

【注】目前apifox helper从IDEA导出Long类型的字段，会自动转为integer类型，测试的时候需要注意精度问题；

【建议】阿里巴巴开发手册建议在使用大整数时，服务端使用String类型返回，避免返回Long类型数据传到前端时，JS自动转换Number丢失精度。

导入接口

Apifox支持多种数据导入，在【项目设置】-【导入数据】中，选择指定格式数据导入即可。

导出接口

Apifox 支持以 OpenAPI (原 Swagger)、HTML、Markdown、Apifox 等数据格式导出接口。

打开“项目设置”面板，点击左侧菜单栏中的“导出数据”选项，选择需要导出的数据格式，点击“导出”按钮即可。

单个接口导出，可以在接口右键快捷导出：

• 导出Markdown格式，可以作为接口文档，Markdown格式可转为其他格式；

• 导出html格式，方便阅读

• 导出的文档中没有接口示例，确认接口的【修改文档页面】，请求参数和返回响应中是否添加了示例。

更多

团队协作等更多功能请参考官方文档 https://apifox.com/help/