API 场景使用文档
面向使用者的操作指南。菜单位置:接口测试 → API 场景。 API 场景用于把多个接口请求编排成完整业务流程(如:登录 → 创建订单 → 支付 → 查询),支持条件分支、循环与变量传递。
一、页面布局

- 左侧:场景目录树(目录 + 场景),与 UI 场景相互独立,支持搜索、右键新建、拖拽排序
- 右侧:选中场景后的步骤编排区 + 调试结果区
- 顶部:场景操作(调试、场景配置、保存等)
二、场景管理
2.1 新建场景
左侧树右键「新建场景」(或选中目录后新建),名称必填。新建的场景/目录固定属于 API 分类,无需选择。
2.2 场景配置
点「场景配置」打开弹窗:
| 配置项 | 说明 |
|---|---|
| 环境绑定 | 选择执行环境,场景内所有请求使用该环境的 baseUrl/变量/Header/Cookie |
| 场景 Header | 追加到场景内每个请求的 Header |
| 场景 Cookie | 追加到场景内每个请求的 Cookie |
| 场景变量 | 场景级变量,可被所有步骤用 ${var} 引用 |
| 场景断言 | 对场景内每个请求统一生效的断言规则 |
优先级(同名覆盖):接口配置 > 场景配置 > 环境配置 > 全局变量。
2.3 复制 / 删除 / 导入导出
- 复制场景会连同全部步骤一起复制
- 删除目录会递归删除其下所有场景和步骤
- 导出为 JSON(自动剥离环境/团队等敏感字段),可导入到其他项目
三、步骤编排
3.1 步骤类型(5 种)
| 类型 | 说明 |
|---|---|
| 接口请求 | 执行一个 API 请求,支持 HTTP 和 SQL 两种(可内联配置,也可引用接口管理中已有的接口/用例/SQL 接口) |
| 等待 | 暂停指定秒数后继续 |
| 条件(IF) | 条件满足才执行子步骤,支持多条件 AND/OR 组合 |
| 循环(FOR) | 按固定次数循环执行子步骤 |
| 条件循环(WHILE) | 每轮先评估条件,满足才继续,带最大循环次数上限保护 |
3.2 编排操作
- 点步骤行「+」添加相邻步骤或子步骤(仅 IF/FOR/WHILE 可含子步骤)
- 步骤行支持:编辑、禁用/启用、复制、删除、拖拽排序
- 条件/循环步骤可多层嵌套
3.3 接口请求步骤
编辑抽屉与 API 测试页面一致:鉴权、URL/方法、Header/Cookie/Query/Body、提取、断言、前后置脚本、Mock(鉴权配置见《API 测试使用文档》2.3 节)。
两种来源:
- 引用已有接口(修改接口管理中接口会联动生效)
- 内联配置(步骤自己持有完整配置,与接口管理互不影响)
3.4 变量传递
- 在某请求的「提取」中配置提取规则(如 JSONPath 提取
token) - 提取结果在运行时写入场景共享变量池
- 后续步骤用
${token}引用 - 步骤树旁的「可用变量」面板按步骤顺序汇总各步提取的变量,方便查找
四、调试执行
4.1 整场景调试
点「调试」:后端逐步执行,每完成一个步骤实时推送结果,可看到:
- 每个步骤的实际请求(URL/Header/Body)与响应
- 断言结果(接口断言 + 场景断言区分展示)
- 提取到的变量
- 循环/条件步骤的子步骤结果逐条增量展示
执行规则:某步骤失败即停止;单场景最长执行 5 分钟;可随时点「终止」中断。
4.2 单步 / 从某步执行
顶级步骤行内下拉菜单:
- 仅执行此步骤:只跑这一步(常用于验证提取/断言配置)
- 从此步骤开始执行:跳过前面步骤(变量池中已有值时有用)
API 场景调试不支持暂停;调试运行期间步骤全部锁定(不可增删改),执行结束自动解锁。
五、计划任务执行
API 场景可加入「任务计划」(计划分类 = API)定时/手动批量执行,执行结果汇总为测试报告。配置入口:自动化测试 → 任务计划。
六、常见问题
- 提取的变量下一步取不到:确认提取规则来源步骤执行成功(失败即停,后续步骤不会执行);在「可用变量」面板确认变量名拼写
- 场景断言和接口断言有什么区别:接口断言只对该步骤生效;场景断言对场景内每个请求统一生效,结果中分开展示
- 调试时改了环境没生效:场景绑定的环境在「场景配置」中;步骤内联请求若自带环境信息,在场景未绑定环境时才生效
