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. 运行测试场景

定时任务

你可以通过设置 “定时任务”,定时自动执行已配置好的自动化测试场景,获取任务运行结果,完成定时测试、回归的需求。
定时任务目前处于 Beta 阶段。
要运行定时任务,首先需要配置一个自托管 Runner。
使用自托管 Runner 运行定时任务,会根据你的团队付费版本有用量限制。了解更多

定时任务入口#

你可以在自动化测试功能的目录树中,找到定时任务分类。项目中的所有定时任务会以结构树形式展示在此。
CleanShot 2025-01-23 at 13.56.41@2x.png
可以在目录树中,添加定时任务或定时任务的目录;以及对某个定时任务/目录做更多的操作。
image.png
image.png
点击定时任务分类,可以在右侧看到以列表形式展示的全部定时任务,及一些基本信息和操作,可以更方便管理。
image.png

定时任务详情#

在目录树上点击一个已有的定时任务,或者新建一个定时任务,则会在右边打开定时任务的详情 tab。
CleanShot 2025-01-23 at 14.00.49@2x.png
可以在定时任务详情中进行如下设置:
任务名称、说明: 用来区别定时任务以及说明该定时任务的详细目的。
启/停用: 开启、停止这个定时任务是否按期执行的开关。
测试场景: 定时任务会执行此处选择的一个/多个测试场景,每个测试场景都可以点击展开独立配置其 “运行配置”。
运行环境、测试数据、循环次数、间隔停顿、保存请求/响应内容等都为标准运行配置,需要了解更多可见此处。
环境/全局变量值,指定本测试场景中的环境/全局变量,使用何种实际值。有两种选择,详细介绍可以查看此处。当选择使用 Runner 中保存的变量值时,会要求进一步选择需要使用的变量范围。有这个范围的目的是帮助用户更好的根据实际需求分隔变量,避免因为某次定时任务运行,而导致其它的任务因为变量被更改而运行失败。选择完成范围后还可通过产品界面中出现的入口来可视化查看此范围内的变量值。
Runner 中的变量范围读写环境/全局变量方式描述
当前测试场景
  • 当前指定运行 Runner 中,此测试场景对应一个文件,在文件中持久化保存此测试场景内设置的环境/全局变量。
  • 仅当前测试场景可以读取、写入这个文件中的变量。
最小的变量范围,影响面最小。适用于此测试场景上一次运行的结果,要继续提供给下一次此测试场景运行使用的情况。
当前定时任务
  • 当前指定运行 Runner 中,此测试场景所属的定时任务对应一个文件,在文件中持久化保存此定时任务内所有测试场景设置的环境/全局变量。
  • 当前定时任务中,所有的测试场景可以读取、写入这个文件中的变量。
比较推荐使用的变量范围,中等的变量范围,影响面中等。适用于此定时任务中,不同测试场景之间需要传递数据的情况。
当前定时任务目录
  • 当前指定运行 Runner 中,此测试场景所属的定时任务目录对应一个文件,在文件中持久化保存此定时任务目录内所有定时任务中测试场景设置的环境/全局变量。
  • 当前定时任务目录中,所有的定时任务里的所有测试场景可以读取、写入这个文件中的变量。
最大的变量范围,影响面最大,可能因为运行了某个定时任务修改了变量值,而导致其他定时任务运行失败。适用于一组定时任务之间需要传递数据的情况。
测试场景详情中的 “保存变量变化值” 配置需被勾选,才能在定时任务运行过程中,将通过前后置操作设置的环境变量或全局变量保存到指定 Runner 的变量范围内。
使用相同运行设置: 让下方的全部测试场景使用同样的运行配置。
运行周期: 设置该定时任务以什么样的定时周期来进行执行,例如每周日晚上 11 点,或每间隔 6 小时执行一次。
运行于: 具体执行此定时任务的实例。可以通过 Apifox 云端(即将开放)、团队自托管 Runner 来执行定时任务。如果团队部署了多台通用 Runner,可以选择其中一台。
通知: 开启通知即可在此定时任务运行完成后,发送一个通知信息给指定的对象,信息内会有测试总览结果和详情链接。打开后可以设置是只要完成运行即进行通知还是在仅发生失败时进行通知,用以减少无效通知的打扰。通知对象的详细说明请参考此处。

定时任务运行#

定时任务运行完成后,会将运行结果从 Runner 上传至服务端中,可以在客户端的 “定时任务 - 运行历史” 中查看选择定时任务的所有运行结果详情。
image.png
建议定时任务开启通知,这样即可在运行完成后第一时间收到通知消息,从而及时查看任务运行结果。
修改于 2025-01-24 08:24:47
上一页
数据驱动测试
下一页
管理其它项目接口的运行环境
Built with