Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 编排测试场景
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
      • 构建数据模型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • SEO 设置
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
  • 账号&应用设置
    • 账号设置
    • 语言设置
    • 网络代理
    • 快捷键
    • 数据备份与恢复
    • 更新 Apifox
    • API 访问令牌
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • 目录链接汇总
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 编排测试场景

新建测试场景

在自动化测试中,测试场景是最基本的单元,类似于 Postman 中的集合 (Collection)。当你需要连续发送多个请求、构建一系列的测试流程,或使用不同的测试数据重复请求时,可以创建一个测试场景,并向其中添加所需的接口或接口用例。
使用 Apifox 的测试场景功能,可以轻松满足各种 API 测试需求:
1.
按顺序发起请求
按指定顺序组织并执行多个请求,模拟用户操作或业务流程。
2.
测试报告
自动生成详细报告,清晰展示断言结果和每个请求的执行情况。
3.
CI/CD 集成
将测试场景集成到 CI/CD 流水线中,实现自动化测试,帮助在开发过程中及时发现问题。
4.
性能测试
在不同负载条件下评估 API 性能,生成趋势分析,揭示响应行为随时间变化的规律。
5.
动态参数测试
使用动态生成的参数多次执行请求,测试 API 如何处理不同的输入。
6.
读取前置步骤数据
利用前置步骤的数据发送请求,模拟真实操作场景,验证 API 响应是否符合预期。
7.
测试步骤间数据传递
自动将一个测试步骤的输出传递给下一个步骤,确保数据流畅传递。
8.
根据逻辑编排测试步骤
配置 if、for 和 foreach 等逻辑条件,根据前一步的结果或特定条件控制测试流程。
这些功能帮助你搭建灵活且高效的测试环境,确保 API 稳定可靠、高质量地运行。

新建测试场景#

在项目中点击左侧菜单栏中的 “自动化测试”,点击搜索栏右侧的 + 号按钮,选择所归属的目录与设置优先级后完成创建。
CleanShot 2024-12-05 at 14.51.23@2x.png
若希望调整测试场景的所在目录,可以在创建测试场景时点击 “目录” 中的 “新建目录” 按钮或选择已有目录进行调整。
你也可以给测试场景设置标签,在左上角的搜索框中通过标签来搜索测试场景。

在测试场景中添加测试步骤#

创建测试场景后可以在其中添加测试步骤。测试步骤中支持导入接口、接口用例、自定义请求和从 cURL 导入接口,并且你还可以在步骤中设置测试条件等附加操作。
进入测试场景后,点击 “添加步骤” 并添加接口。你可以选择 “从接口导入” 和 “从接口用例导入”。
image.png

从接口导入#

你可以从当前项目中导入接口作为测试场景的步骤。导入接口时有两种同步模式:“手动同步” 和 “自动同步”。具体说明请参阅从接口/用例同步数据。
手动同步
在此模式下,项目内的 “接口文档” 发生数据变化时,测试步骤中的接口数据不会自动更新。只有当测试人员点击 “手动同步” 按钮时,测试步骤中的接口数据才会与接口文档中的数据同步。如果测试步骤中的接口数据发生了变化,点击 “手动同步” 按钮后,数据不会同步回接口文档,而是重新抓取接口文档中的数据并与之同步。
自动同步
在此模式下,当项目内的 “接口文档” 数据发生变化时,测试步骤中的接口数据将自动更新。
image.png
如果你需要在一个测试场景中测试其它项目的接口,可以参考跨项目导入接口/用例。

从接口用例导入#

你可以选择从当前项目或其他项目导入接口用例。导入接口用例时有两种模式:分别是 “复制” 和 “引用” 模式。
复制
以 “复制” 方式导入接口用例时,接口用例中的参数也会一并复制到测试步骤中,且与原项目内的接口用例数据相互独立。两者的改动互不影响。
引用
以 “引用” 方式导入接口用例时,将直接使用原项目内的接口用例进行请求。
image.png
如果是从接口用例引用的测试步骤,点击进入这个步骤后,会显示一个明确的提示。这个提示会告知你:修改当前步骤的内容不仅会影响原始的接口用例,还会同时影响所有引用了该接口用例的其他测试步骤。
image.png

添加自定义请求#

在业务流程中,可能会遇到需要调用外部项目接口的情况,例如调用第三方支付接口。你可以在测试步骤中添加自定义请求,自定义请求可以是任意 HTTP 请求类型,包括常见的 GET、POST、PUT、DELETE 等。
image.png

从 cURL 导入#

在实际业务流程中,许多 API 请求以 cURL 命令行的形式呈现。你可以将 cURL 请求一键导入到测试步骤中。
image.png

流程控制条件#

你可以在测试场景中新增流程控制条件 (如分组、条件分支、ForEach 循环、For 循环和等待时间),以应对更复杂的测试场景和流程配置需求,最终通过自动化测试功能解决复杂场景的测试工作。
image.png

从其它测试场景导入#

你可以将当前项目中其他测试场景的测试步骤或流程控制条件复制导入到当前测试场景。
image.png

引用其它测试场景#

你可以在测试场景中引用其他测试场景,将其作为一个测试步骤。以下是该功能的适用场景:
1.
当业务流程中有一些公共且可复用的步骤时,可以将这些步骤组合成一个小型测试场景,然后在其他较大的测试场景中直接引用。
2.
如果需要执行全产品的主流程回归测试,可以在一个测试场景中引用各个子测试场景进行组装,从而实现一键测试全部主流程,完成回归工作。
image.png
为防止出现无限循环或测试场景无法正常停止的情况,该功能不可引用当前测试场景本身。

编排测试场景#

点击任意测试步骤即可进入编排模式。在该模式下,你将拥有更大的操作页面 (点击左上角的放大图标可将页面方放大),便于更高效地填写每个测试步骤的详细内容。页面左侧显示测试场景的整体流程,右侧显示选中测试步骤的详细信息。接口请求和流程组件将根据其类型展示不同的详情。
你可以在此模式中使用“⬆️”“⬇️”按键来快速切换选中的测试步骤。
image.png
在编排模式中,你可以同时编辑多个步骤,并通过点击左上角的 “全部保存” 按钮一次性保存所有步骤的详细信息。如果某个步骤的详细内容未保存,该步骤将在左侧列表中标记一个小圆点。请务必注意并及时保存已填写的内容。
修改于 2025-01-06 07:20:02
上一页
概述
下一页
测试步骤间传递数据
Built with