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. 编排测试场景

测试步骤间传递数据

在自动化测试场景中,多个测试步骤之间传递数据是很常见的。典型场景包括:
测试步骤 1 是登录接口,返回 token;测试步骤 2 使用这个 token 请求其他数据。
测试步骤 1 返回一个 ID;测试步骤 2 基于这个 ID 进行操作。
测试步骤 1 返回一个列表;测试步骤 2 使用这个列表中的数据。
针对这类场景,Apifox 提供了两种不同的解决方案来处理测试步骤之间的数据传递。你可以根据具体问题选择合适的方案:
1.
读取前置步骤的运行结果
该功能允许你在后续测试步骤中直接使用前一个步骤的结果。
优点:操作简便,无需引入额外变量。
缺点:当数据需要多次引用时,可能会显得繁琐。
注意:该功能仅适用于 “自动化测试” 模块,不能在 “接口管理” 模块中使用。
2.
使用变量传递数据
在前一个测试步骤的后置操作中,通过 “提取变量” 存储数据,并在后续步骤中引用这些变量。
优点:便于在多次引用数据时使用,但对于单次引用来说,可能稍显复杂。
缺点:需要手动管理变量,增加了一些配置的复杂度。
注意:变量可以在 自动化测试 和 接口管理 模块中使用。

读取前置步骤的运行结果#

我们以一个场景为例,测试步骤 1 是登录接口返回 token,测试步骤 2 使用这个 token 请求其他数据。
1
把登录接口 (测试步骤 1) 添加到测试场景中。
2
把查询接口 (测试步骤 2) 添加到测试场景中。
3
测试步骤 2 的 “Query 参数” 需要包含测试步骤 1 返回的 token。点击测试步骤 2 “Query 参数” 中 token 字段的魔法棒图标,选择 “读取前置步骤的运行结果”。
image.png
4
选择从测试步骤 1 获取数据,选择响应体,使用 JSONPath 表达式提取测试步骤 1 返回的 token,比如 $.token。
image.png
5
点击插入,可以看到查询参数中插入了 {{$.1.response.body.token}}。
image.png
6
点击测试场景中的 “运行” 按钮,就能成功地把数据从测试步骤 1 传递到测试步骤 2。你可以在测试报告的 “实际请求页” 中查看
image.png
“读取前置步骤的运行结果” 功能只能在 “自动化测试” 模块使用,不能在 “接口管理” 模块使用。
使用 “读取前置步骤的运行结果” 时,只有运行整个测试场景才能获取到值,单独运行某个步骤是无法获取的。

通过变量语法引用前置步骤数据#

除了使用 “读取前置步骤的运行结果” 来引用数据,你还可以通过变量语法来实现这一功能。以上文的 {{$.1.response.body.token}} 为例:
表达式里的 1 表示步骤 ID,可以在每个测试步骤中找到。
表达式里的 response.body 表示前置步骤数据的位置。可以包括请求的 header、body,或者响应的 header、body 等数据。具体见下文。
image.png
表达式里的 token 表示 body 中下一层级的 token 字段数据。你可以使用 JSONPath 语法提取想要的数据。
前置步骤数据可以在请求的各个部分使用,比如请求参数、请求头等。你也可以直接把数据插入到请求体中,如下图所示。
要注意的是,如果你需要在脚本中使用前置步骤数据,不能直接用 {{variable}} 语法引用变量,而是要使用 pm.variables.get 引用前置步骤数据。比如:

语法参考#

类别功能语法示例
请求URL{{$.<step id>.request.url}}
路径参数{{$.<step id>.request.pathParam.<field name>}}
查询参数{{$.<step id>.request.query.<field name>}}
请求头{{$.<step id>.request.header.<field name>}}
请求体(form){{$.<step id>.request.body.<field name>}}
请求体(json){{$.<step id>.request.body.<field path>}}
响应响应体{{$.<step id>.response.body.<field path>}}
响应头{{$.<step id>.response.header.<field name>}}
Cookie{{$.<step id>.response.cookie.<field name>}}
循环元素(ForEach 循环中的数组元素){{$.<loop step id>.element.<field path>}}
索引{{$.<loop step id>.index}}

使用变量传递数据#

假设有一个测试场景,其中测试步骤 1 是调用登录接口并返回一个 token,而测试步骤 2 则使用这个 token 来请求其他数据。
1
把登录接口 (测试步骤 1) 添加到测试场景中。
2
在测试步骤 1 的后置操作中,添加一个 “提取变量” 的操作,把 $.token 提取为 {{token}}。
image.png
了解更多提取变量。
3
把查询接口 (测试步骤 2) 添加到测试场景中。
4
在测试步骤 2 的 Query 参数中引用变量 {{token}}。
image.png
5
点击测试场景中的 “运行”按钮,就能成功地把数据 (提取出来的 token) 从测试步骤 1 传递到测试步骤 2。

常见问题#

为什么我无法成功引用前置步骤数据?
首先,确认你是在 “自动化测试” 模块中使用此功能。“读取前置步骤的运行结果” 只在自动化测试模块有效,不能在接口管理模块使用。
如果你已经在自动化测试模块,请切换到测试报告,查看具体某个接口的 “实际请求” 标签页,确认请求中引用的前置步骤数据是否已成功填充。
如果实际请求中显示的仍是 {{$.n.response.body.abc}} 而非实际数据,说明引用未生效。
常见原因如下:
1.
是否运行了整个测试场景? 引用前置步骤数据需要运行完整的测试场景才能生效,单独运行某个步骤不会生效。
2.
步骤 ID 是否正确? 请确保引用的步骤 ID 与目标步骤对应。
3.
JSONPath 是否准确? 确认使用的 JSONPath 与数据源结构匹配。
修改于 2025-02-06 03:33:25
上一页
新建测试场景
下一页
测试流程控制条件
Built with