接口调试 / 接口用例

# 接口调试 / 接口用例

设计好接口文档后,就可以直接运行接口来调试了。

新人注意

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

  • 接口设计:即 新建接口 界面或接口详情里的 编辑 界面,用途是 定义接口文档规范,而不是 运行 接口,所以该界面是只能定义接口基本信息、参数名及参数说明等,而不能设置参数值参数值前置脚本/后置脚本 等信息请在接口运行界面或接口用例界面填写。
  • 接口运行:即接口详情里的 运行 界面,用途是 临时调试接口运行 完后,需要点击保存为用例,才能将填写的 参数值前置脚本/后置脚本 等信息保存下来;否则关闭 tab 后,这些信息将会丢失。

新人常见问题

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

# 快速上手

打开接口详细,点击运行 tab 即可。

# 接口参数

在接口运行的时候,接口路径、参数名会自动从接口设计读取,无需手动输入,参数值默认会读取接口设计里的示例值,可手动修改。

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

# 保存为用例

保存为用例是将当前填写的参数保存起来,方便下次或者其他人用来调试接口。

保存为用例后,接口用例会显示在左侧树状菜单里接口的下一级(如上方截图展示)。

注意

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

# 返回 Response

返回 Response是用来给系统校验接口请求后返回的数据是否符合对应 Response 里定义的数据结构,免去人眼识别,提高效率和准确性。

# 数据结构校验结果

系统会根据选择的返回 Response的数据结构,自动分析运行后返回的数据是否正确,并且给出详细的错误提示。

# 断言

后置操作支持添加断言,可对接口返回的数据(或响应时间)设置断言,判断是否符合预期。查看断言功能文档

# 提取变量

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

# 控制台

控制台主要用来展示,脚本里输出的调试信息,以及脚本运行时的错误信息,方便进行脚本调试。