接口调试 / 接口用例

新人注意

和 Postman 不一样，Apifox 是区分接口设计和接口运行两个概念的。

• 接口运行：即接口详情里的 运行 界面，用途是 临时调试接口，运行 完后，需要点击保存为用例，才能将填写的 参数值、前置脚本/后置脚本 等信息保存下来；否则关闭 tab 后，这些信息将会丢失。

新人常见问题

• 如何像 Postman 那样不用提前设计接口就能快速调试？ 使用 功能。
• 如何固定 tab，避免新打开接口的时候覆盖掉已打开的 tab？ 双击 tab 头或者双击树形菜单的对应内容，用法和 VS Code完全一样。（修改tab里的内容后，会自动固定 tab）

打开接口文档，点击运行 tab 即可。

保存为用例

保存为用例 是将当前填写的参数保存起来，方便下次或者其他人用来调试接口。保存为用例后，接口用例 会显示在左侧树状菜单里接口的下一级（如上图）。

注意

• 接口用例是非常有用的。从团队协作的场景出发，建议每次运行后都保存为用例，后续用接口用例来调试接口是非常高效的。
• 通常一个接口会有多种情况用例，比如参数正确用例、参数错误用例、用例、不同数据状态用例等等。

2. 参数值默认读取 修改文档 里的 示例值，也可手动修改，进行调试

3. 填写好参数后，点击发送按钮即可运行。

前置操作/后置操作

前置操作/后置操作 的设置维度支持 项目维度、分组维度、单个接口、单个接口用例

1. 分组维度：点击对应的 分组 即可设置，会对分组下的接口/接口用例生效。

1. 单个接口：在 接口文档-运行 页设置 前置操作/后置操作 ，需要 保存为接口用例 ，点击 保存 不会被保存在接口文档中，也不会对该接口下面的 接口用例 生效。

1. 单个接口用例：在 接口用例 中设置 前置操作/后置操作 ，只对本 接口用例 生效

断言

提取变量

支持添加提取变量，可从接口返回结果里提取数据，设置到变量（临时变量/环境变量/全局变量），方便其他接口运行的时候直接使用。查看提取变量功能文档

校验响应 是一个高效的测试工具，以 接口文档-修改文档 页面内填写的 返回响应 作为判断标准，与 请求接口 的获得的返回值进行对比。

1. 校验响应 的校验范围：

• 接口返回的 HTTP 状态码
• 返回内容的数据格式：JSON、XML、HTML、Raw、Binary
• 数据结构：仅JSON、XML可配置数据结构，关于数据结构详细说明，请查看文档：数据结构/数据模型

1. 如果上述 2 者一致，则显示 ”返回数据结构校验通过!“。说明真实的接口返回值是符合接口文档定义的，不需要人工核对，提高效率和准确性。

1. 校验响应 开关默认打开。可以在界面左下角 设置-通用-校验响应 关闭全局开关，注意：全局开关只会对 接口文档-运行 生效，不会对已保存的 生效。

控制台