Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. Mock 数据
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 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. Mock 数据

Mock 数据

Apifox 提供了一个高效的 Mock 引擎,能够根据接口文档自动生成合理的响应数据,无需额外配置。
Mock 数据可应用于以下场景:
1.
前后端并行开发时,API 文档已完成但接口尚未开发,前端可以使用 Mock 数据进行开发。
2.
当 API 涉及不便直接调用的生产数据时,前端可以借助 Mock 数据进行开发。
3.
测试过程中,外部数据需要测试数据集时,可以使用 Mock 数据作为数据源。

开始使用#

1
指定一个接口或导入接口文档,这个接口需要有设定好的返回值。
2
复制 Mock URL:
在 “文档模式” 下,位于 “接口” 标签页中。
image.png
在 “调试模式” 下,位于 “Mock” 标签页中。
image.png
3
访问这个 URL 就能获取 Mock 数据,刷新页面数据就会更新。
CleanShot 2024-11-29 at 16.42.18@2x.png

Apifox 的 Mock 功能能做什么?#

Apifox 的 Mock 功能可以满足以下需求:
1.
根据接口文档自动生成数据
2.
返回接口文档中指定的响应示例
3.
返回自定义的指定响应数据
4.
根据不同的请求参数返回不同的自定义响应
5.
根据请求参数返回相关的响应数据

Mock 服务器#

Apifox 提供了三种 Mock 方式:本地 Mock、云端 Mock 和 Runner Mock。

本地 Mock#

本地 Mock 是与 Apifox 客户端一起安装的本地服务器,它会在 Apifox 客户端启动时自动启用,并且只有在 Apifox 客户端运行时才能使用。
本地 Mock 适用于本地前端调试场景
你可以在环境管理弹窗中的本地 Mock 环境下查看该本地 Mock 服务器的 URL
image.png
本地 Mock 服务器不能关闭或从环境中移除
本地 Mock 只能在 Apifox 客户端使用,网页版不支持

云端 Mock#

云端 Mock 的功能与本地 Mock 相同,但它部署在 Apifox 的服务器上。与本地 Mock 不同,云端 Mock 不依赖本地机器的开启,您可以在任何机器上随时访问云端 Mock 数据。
云端 Mock 适用于公开 API 的沙箱环境
云端 Mock 支持加密访问
默认情况下为关闭状态,您可以随时开启或关闭云端 Mock。
CleanShot 2024-11-29 at 16.46.03@2x.png
Apifox 提供的云端 Mock URL 会不定时变更,仅供测试使用,“切勿” 用于生产环境。
了解更多云端 Mock的信息。

Runner Mock#

Runner Mock 服务器部署在团队自有的 Runner 上。团队需要先在服务器上部署 Runner,之后所有成员都可以使用该 Runner 来 Mock 数据,它不依赖于本地机器是否开启。
Runner Mock 适用于大规模自动化测试的数据源或非公开 API 的沙箱环境。
了解更多自托管 Runner Mock的信息。

访问 Mock 服务器#

访问 Mock 服务器主要有两种方式:URL 访问和 Apifox 发送。

URL 访问#

在 Apifox 的每个 HTTP 接口中,都可以找到“Mock”模块。
在 “文档模式” 下,位于 “接口” 标签页中;
在 “调试模式” 下,位于 “Mock” 标签页中。
在这里,你可以复制 Mock URL,并在任何地方使用它来请求 Mock 数据。
如果接口配置了多个响应或多个 Mock 预期,每个响应/预期都会有独立的 Mock URL。
image.png
你可以点击 “快捷请求” 按钮直接在 Apifox 中发起这些请求。
请注意,如果使用 “点击复制”,它只会复制 URL,不包括请求方法和请求体。在发起请求时,你需要手动添加这些必要的部分。

在 Apifox 中访问 Mock 数据#

在每个 Apifox 项目中,你可以在右上角的环境管理中找到本地 Mock 和云端 Mock。
当你将环境切换到本地 Mock 或云端 Mock 时,Apifox 中的请求将会发送到对应的 Mock 环境。
只有路径以 "/" 开头的 Apifox 接口才会发送到 Mock 环境。带有自定义前置 URL 或不以 "/" 开头的接口将不会发送到 Mock 环境。

Mock 请求 URL 使用说明#

在使用 Mock 功能时,请确保请求的 Method 与接口定义中的一致。假设:
项目 ID:18600
接口 ID:89343
接口路径:/users/123
请求方式:POST
则对应的 Mock 请求地址如下:

本地 Mock 地址#

云端 Mock 地址#

只需定义接口或数据结构,Apifox 即自动生成 Mock 数据,无需额外配置,访问上述地址即可获取返回结果。

Mock URL 格式说明#

本地 Mock#

路径模式
http://127.0.0.1:4523/m1/{项目 ID}-{版本编号}-{服务编号}/{接口路径}
示例:
http://127.0.0.1:4523/m1/18600-0-0/users/123
ID 模式
http://127.0.0.1:4523/m2/{项目 ID}-{版本编号}-{服务编号}/{接口 ID}
示例:
http://127.0.0.1:4523/m2/18600-0-0/84924

云端 Mock#

路径模式
https://mock.apifox.cn/m1/{项目 ID}-{版本编号}-{服务编号}/{接口路径}
示例:
https://mock.apifox.cn/m1/18600-0-0/users/123
ID 模式
https://mock.apifox.cn/m2/{项目 ID}-{版本编号}-{服务编号}/{接口 ID}
示例:
https://mock.apifox.cn/m2/18600-0-0/84924
注意
Apifox 提供的云端 Mock URL 会不定时变更,仅供测试使用,“切勿” 用于生产环境。若有需要可以使用自托管 Runner Mock功能。

参数说明#

项目 ID:在 Apifox 中打开项目,进入「项目设置」页面查看。
image.png
接口 ID:在「接口名称」处即可查看。
image.png
版本编号:默认填写 0,表示主版本(多版本功能尚未上线)。
服务编号:默认服务填写 default。当默认服务下不存在该接口时,系统会自动查找其他服务中的同路径接口。

使用提示#

使用建议
1.
本地 Mock 服务默认监听在 127.0.0.1,如需其他设备访问,请将 IP 替换为本机局域网地址。若无法访问,请检查防火墙或端口 4523 是否被拦截。
2.
若项目内存在多个接口具有相同的 Method + Path,请使用以下方式避免冲突:
路径模式:添加 ?apifoxApiId={接口 ID} 查询参数。
ID 模式:无需额外操作,直接使用接口 ID。
3.
若接口路径不是以 / 开头,只能使用 接口 ID 模式。
4.
启动 Apifox 即默认启动 Mock 服务,无需手动开启。
5.
Mock 服务的 前置 URL 是固定的,无法修改。

本地旧版 Mock#

路径模式
http://127.0.0.1:4523/mock/{项目 ID}/{接口路径}
示例:
http://127.0.0.1:4523/mock/18600/users/123
ID 模式
http://127.0.0.1:4523/mock2/{项目 ID}/{接口 ID}
示例:
http://127.0.0.1:4523/mock2/18600/84924
当前仍支持旧版地址,但将逐步废弃,建议尽快切换到新版格式。

如何获取接口 Mock URL?#

进入「接口详情」页面,点击右侧的「Mock」模块,即可查看当前接口的 Mock 地址。
image.png
修改于 2025-04-15 03:20:18
上一页
报文数据处理器
下一页
智能 Mock
Built with