跳到主要内容

词汇表

接口设计

定义接口规范(如接口路径、参数、返回值、数据结构等),也就是编写接口文档

接口运行

输入特定的接口参数,然后运行,主要用来调试接口。接口运行完之后点击保存为用例按钮,即可生成接口用例,后续可直接运行接口用例,无需再输入参数,非常方便。

新人注意

和 Postman 有所差异的,Apifox 区分接口设计接口运行两个概念。

  • 接口设计:即 新建接口 界面或接口详情里的 编辑 界面,用途是 定义接口文档规范,而不是 运行 接口,所以该界面是只能定义接口基本信息、参数名及参数说明等,而不能设置参数值。参数值、前置脚本/后置脚本 等信息请在接口运行界面或接口用例界面填写。

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

接口用例

通常一个接口会有多种情况用例,比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。

数据模型

可复用的数据结构,定义接口返回数据结构请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。

集合测试

多接口集成测试,主要有功能测试性能测试对比测试

快捷请求

类似 Postman 的接口调试方式,主要用途为临时调试一些无需文档化的接口,无需提前定义接口即可快速调试。

代码生成

根据接口及数据数据模型定义,系统自动生成接口请求代码前端业务代码后端业务代码