Apifox 帮助文档
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开发者中心
开放 API
Apifox Markdown
更新日志
Road Map
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开发者中心
开放 API
Apifox Markdown
更新日志
Road Map
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
导入导出数据
复制页面
帮助中心
更新日志
入门
产品介绍
私有化部署
联系我们
开始使用
下载 Apifox
基本概念
注册与登录
页面布局
快速上手
概述
新建接口
发送接口请求
快捷请求
添加断言
新建测试场景
分享 API 文档
了解更多
导入导出数据
导出数据
概述
定时导入(绑定数据源)
导入设置
手动导入
其它方式导入
导入 cURL
导入 Markdown
导入 Insomnia
导入 apiDoc
导入 .har 文件
导入 Apipost
导入 Eolink
导入 knife4j
导入 NEI
导入小幺鸡(docway)
导入 Apizza
导入 WSDL
导入 Postman
导入 OpenAPI/Swagger
设计 API
概述
新建 API 项目
接口基础知识
接口设计规范
模块
请求体多示例配置
响应组件
常用字段
全局参数
历史记录
接口评论
批量管理
通用接口文档
以 OpenAPI 文件维护接口
基础知识
接口基本信息
请求头
HTTP/2
请求参数编码解码
请求参数与请求体
请求 URL 与方法
认证与授权
概述
支持的授权类型
Digest Auth
OAuth 1.0
OAuth 2.0
Hawk Authentication
Kerberos
NTLM
Akamai EdgeGrid
CA 和客户端证书
响应与 Cookie
概述
API 响应
创建和发送 Cookie
实际请求
提取响应示例
请求代理
网页端中的请求代理
分享文档中的请求代理
客户端中的请求代理
API Hub
API Hub
数据模型
概述
高级数据类型
构建数据模型
通过 JSON 等生成
新建数据模型
数据模型进阶
使用 oneOf / anyOf / allOf 构建组合模式
使用 discriminator 实现多态数据结构
鉴权组件
概述
创建鉴权组件
使用鉴权组件
在线文档中的鉴权组件
高级功能
参数列表外观
接口唯一标识
关联测试场景
接口状态
接口字段
开发和调试 API
概述
生成请求
发送请求
请求历史
接口调试用例
单接口用例
动态值
校验响应
文档模式/调试模式
生成代码
环境和变量
概述
环境管理
全局/环境/模块/临时变量
Vault Secrets(密钥库)
功能简介
前后置操作&脚本
概述
断言
提取变量
等待时间
安全性
数据库操作
概述
MySQL
MongoDB
Redis
Oracle
使用脚本
概述
前置脚本
后置脚本
公共脚本
pm 脚本 API
使用 JS 类库
响应数据可视化
调用外部程序
脚本示例
断言示例
脚本使用变量
脚本读取/修改接口请求信息
常见问题
如何获取动态参数的真实值并加密?
脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
API 调试
SSE 调试
MCP 调试
GraphQL 调试
WebSocket 调试
Socket.IO 调试
SOAP/WebService
gRPC 调试
Webhook 调试
AI Agent Debugger
A2A Debugger
使用请求代理调试
Dubbo 调试
新建 Dubbo 接口
调试 Dubbo 接口
Dubbo 接口文档
TCP(Socket)
Socket 接口功能简介
报文数据处理器
Mock 数据
概述
智能 Mock
自定义 Mock
Mock 优先级
Mock 脚本
云端 Mock
自托管 Runner Mock
自动化测试
概述
编排场景用例
新建场景用例
测试步骤间传递数据
测试流程控制条件
从接口/用例同步数据
跨项目导入接口/用例
导出场景用例数据
运行场景用例
运行场景用例
批量运行场景用例
数据驱动测试
共用测试数据
定时任务
管理其它项目接口的运行环境
测试套件
概述
新建测试套件
编排测试套件
本地运行测试套件
定时任务
测试报告
测试报告
API 测试
性能测试
集成测试
端到端测试
回归测试
契约测试
Apifox CLI
概述
安装和运行 CLI
CLI 命令选项
CLI 运行测试套件
使用 Apifox CLI 搭配 AI Agent
CI/CD
概述
Git 提交自动触发测试
与 Gitlab 集成
与 Jenkins 集成
与 Github Actions 集成
与其它更多 CI/CD 平台集成
发布 API 文档
自定义域名
概述
快捷分享
SEO 设置
页面布局设置
AI 相关特性
发布文档站
自定义页面代码
查看 API 文档
高级设置
文档站搜索设置
跨域代理
文档站接入 Google Analytics
文档左侧目录设置
文档可见性设置
在线 URL 链接 规范
API 版本
功能简介
创建 API 版本
发布 API 版本
快捷分享 API 版本
迭代分支
功能简介
新建迭代分支
在迭代分支中改动 API
在迭代分支中测试 API
合并迭代分支
管理迭代分支
AI 分支
管理中心
基本概念
团队入驻
管理项目
项目基本操作
项目成员管理
通知设置
功能简介
通知对象
通知事件
项目资源
数据库连接
Git 仓库连接
管理团队
团队基本操作
团队成员管理
成员角色与权限设置
团队动态
团队资源
通用 Runner
请求代理 Agent(Proxy)
团队变量
实时协作
团队协作
管理组织
组织基本操作
审计日志
管理组织内的团队
单点登录(SSO)
功能简介
为组织配置单点登录
管理用户账号
将组映射到团队
Microsoft Entra ID
SCIM 用户管理
功能简介
Microsoft Entra ID
组织资源
自托管 Runner
安全管理
密钥扫描
订单管理
管理订阅
组织付费经理
离线空间
功能简介
IDEA 插件
快速上手
生成接口文档
生成数据模型
配置
全局配置
项目内配置
可配置规则
脚本工具
Groovy 本地扩展
进阶配置
注释规范说明
框架支持
常见问题
常见问题
浏览器扩展
Chrome
Microsoft Edge
Apifox AI 功能
总览
启用 AI 功能
生成测试用例
修改数据模型
接口规范性检测
接口文档完整性检测
字段命名
常见问题
Apifox MCP Server
新版 MCP 内测
概述
通过 MCP 使用 Apifox 项目内的 API 文档
通过 MCP 使用公开发布的 API 文档
通过 MCP 使用 OpenAPI/Swagger文档
最佳实践
概述
接口之间如何传递数据
登录态(Auth)如何处理
接口签名如何处理
如何加密/解密接口数据
Jenkins 定时触发任务
如何计算 AI 问答成本
与其他成员共用数据库连接配置
通过 CLI 运行包含云端数据库连接配置的测试场景
通过 Runner 运行包含云端数据库连接配置的测试场景
Apifox 测试步骤之间怎么传递数据?
账号&应用设置
账号设置
API 访问令牌
通知
语言设置
快捷键
网络代理
数据备份与恢复
更新 Apifox
实验性功能
身份验证 & 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
动态值表达式
常见问题
导入导出数据
复制页面
导入设置
在
手动导入
和
定时导入
时,都会出现一系列的导入选项,示例如下:
Basic auth
#
如果你是通过 URL 导入的,有些 URL 可能使用了 Basic auth 加密。在这种情况下,只需打开 Basic auth 开关并填写用户名和密码即可。
导入目标设置
#
目标分支
#
选择你想将数据导入到项目的哪个工作分支(通常默认为
main
主分支)。
导入到
#
你可以选择将新接口和数据导入到项目已有的模块中,或者直接创建一个全新的模块来存放它们。
接口和用例设置
#
自动生成接口用例
#
如果导入的文档不包含具体的测试用例,开启这个选项后,Apifox 会为每个接口自动生成一个默认的 “成功” 用例,方便你快速开始测试。
导入 Servers 为环境
#
如果导入的文档中定义了不同的服务器地址,开启后,Apifox 会将这些地址自动创建为项目中的不同环境,方便你切换测试目标。
安全和鉴权处理
#
Security Scheme(鉴权组件)是在 API 文档(例如 OpenAPI)里用来描述接口授权方式的配置。
它告诉客户端:访问接口时应该怎么携带认证信息,例如 Token、API Key、或 OAuth2 授权等。
导入 Security Scheme
#
开启后,会将文档中定义的各种安全设置(如 API Key、Basic Auth 等)导入到 Apifox 的 Auth 中。
你可以选择将 “导入文档” 中定义的全局鉴权配置,应用于 Apifox 项目根目录的 Auth 设置。
对于那些在 “导入文档” 中未明确设置 Security 的接口,你可以指定它们的处理方式,例如:继承父级目录的 Auth 配置,或者统一设置为“无需鉴权”。
命名规则和 Summary
#
接口 Summary 为空
#
如果导入的接口没有一个清晰的名字(
Summary
),Apifox 会默认使用接口的
operationId
字段作为接口的名称。你也可以使用 path,或者从 description 提取。
资源冲突处理
#
当导入的数据与项目中的接口、数据模型或组件发生重复时,你需要决定如何处理。
接口冲突
#
当导入的接口与现有接口的
方法(Method)和路径(Path)完全相同
时:
覆盖已有接口
:新导入的接口会完全替换掉旧的接口内容。
保留两者
:两个接口都会被保留在项目中。
不导入
:直接忽略新导入的这个冲突接口。
智能合并
: 会保留旧接口内修改的中文名、Mock 规则、参数说明和接口的响应示例等。
覆盖指定字段
:选中的字段会被覆盖,其他未选中字段会保留现有的内容。
Markdown、数据模型和组件
#
对于 Markdown 文件、数据模型和组件的冲突处理,有类似的下拉列表可供选择,例如选择 “覆盖” 或者 “智能合并”。
目录同步
#
当导入的接口与项目中的接口匹配时,但它们所属的目录信息(如目录名称、前/后置操作等)在新旧文件中不一致时,你可以选择:
保持已有接口的目录不变
:忽略新文件的目录信息,保留项目里原有的目录设置。
更新接口目录
:用新文件中的目录信息来更新项目里接口所属的目录。
资源清理
#
Apifox 会比较导入的新文件和项目中的现有资源:
不删除
:项目中那些在新文件中不存在的旧资源会被保留下来(安全选项)。
删除
:项目中那些在新文件中不存在的旧资源会被从项目中移除(同步选项,可以保持项目与导入源数据完全一致)。
上一页
定时导入(绑定数据源)
下一页
手动导入