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

从接口/用例同步数据

简介#

针对从接口/接口用例导入的测试步骤,其请求数据可以和关联的接口文档/接口用例进行同步。
image.png
在测试步骤中导入接口/接口用例时可以选择 “手动同步” 或 “自动同步” 模式。
手动同步模式适合多人分工协作场景,即一个项目中的接口定义、研发、测试流程有着明确分工,每个流程有专门的负责人。流程之间要求数据独立,避免意料之外的改动相互影响。确保接口/接口用例数据稳定后,测试人员再手动同步至测试步骤。
自动同步模式适合小团队或独立开发者场景,即一个项目中的接口定义、研发、测试流程均由一个角色负责,提升接口维护与测试的效率。当 “接口管理” 中的接口/接口用例发生变动时,测试步骤中的接口/接口用例数据也将联动调整,确保 “接口管理” 和 “自动化测试” 中的数据相一致。

同步关系表#

测试步骤生产方式关联数据测试步骤同步模式同步内容
从接口导入 - 手动同步接口文档手动同步(在测试步骤中点击"同步"按钮)✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。

❌ “参数值”。
从接口导入 - 自动同步接口文档自动同步(接口文档变更保存时)✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。

❌ “参数值”。
从接口用例导入 - 复制接口文档手动同步(在测试步骤中点击"同步"按钮)✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。

❌ “参数值”。
从接口用例导入 - 引用接口用例自动同步(接口用例变更保存时)✅ 引用接口用例数据,在接口用例中的任何变动都会影响此测试步骤内容。

手动同步#

选择手动同步模式,关联按钮将显示为 “蓝色”。当 “接口管理” 中的接口文档有任何改动时,测试步骤中的数据不会实时同步改动内容。测试人员可以在 “测试步骤” 详情中手动点击 “立即同步” 按钮将接口文档/接口用例改动同步至此。
此模式适用于测试角色在保存有大量的接口微调请求参数的实际提测场景,避免这些测试数据受到预期之外的影响,确保测试数据与正在开发的接口数据作出隔离。在手动同步模式下,关联按钮的下拉框中还支持手动筛选数据的同步范围。
image.png

同步接口文档#

如果选择 “从接口导入 -> 手动同步”,以及 “从接口用例导入 -> 复制” 这两个操作项,关联内容则为接口文档。这种测试步骤通过点击页面中的 “立即同步” 按钮可触发与接口文档内容的同步。
触发手动同步后,测试步骤将同步接口文档中的数据,包括参数名、前后置脚本等内容。注意同步的对象是接口文档,如果接口文档的请求参数中没有设置示例值的话,同步内容是不包含 “参数值” 的。
测试角色需要在测试步骤中手动点击 “立即同步” 按钮触发数据同步机制,点击后将提示为 “已同步”。确认同步后的数据无误后,还需点击右上角的 “保存” 按钮保存测试步骤。
image.png

批量同步数据#

若当前测试步骤中的大部分数据都采用了手动同步模式,而测试人员已经确认这些接口文档/用例的数据无误,希望将数据快速同步至测试步骤中,那么可以在测试步骤页点击 “立即同步” 按钮执行批量同步操作。
image.png

自动同步#

关联按钮将显示为 “橙色”。此模式适合小团队或独立开发者场景,即一个项目中的接口定义、研发、测试流程均由一个角色负责。当 “接口管理” 中的接口文档发生变动时,测试步骤中关联的数据将自动同步并保持一致,提升接口维护与测试的效率。
image.png

同步接口文档#

跟接口文档关联的测试步骤,数据同步方式为自动同步时,接口文档有变更被保存,数据将实时更新至此测试步骤中。同步的内容跟上文中的手动同步模式相一致。
在自动同步模式下,测试步骤内的数据与接口文档的数据的不一致会被高亮呈现出来,测试人员可以选择 “复原” 来保持跟接口文档完全一致;也可以选择 “保存到文档”,此时测试步骤内的数据将反向覆写回接口文档,使得两者保持一致。
image.png

同步接口用例#

引用接口用例的测试步骤,接口用例与测试步骤将使用同一套请求数据。为了让这个逻辑更加清晰直观,同时也为了确保 “接口管理” 对于接口用例数据的管理唯一性,所以变更都需要在 “接口管理” 中的被引用接口用例里进行调整。
点击测试步骤页面指引中的 “去修改” 按钮后,前往关联的接口用例页进行调整。测试步骤将自动同步接口用例变更后的数据,包括参数名、参数值、前后置脚本等所有请求内容。
image.png
修改于 2024-12-05 09:56:17
上一页
测试流程控制条件
下一页
跨项目导入接口/用例
Built with