Apifox 帮助文档
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
鉴权组件
复制页面
帮助中心
更新日志
入门
产品介绍
联系我们
私有化部署
开始使用
下载 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
概述
接口的组织方式
模块
接口基础知识
请求体多示例配置
响应组件
常用字段
全局参数
历史记录
批量管理
数据模型
概述
新建数据模型
构建数据模型
通过 JSON 等生成
高级数据类型
鉴权组件
概述
创建鉴权组件
使用鉴权组件
在线文档中的鉴权组件
高级功能
接口字段
接口状态
关联测试场景
参数列表外观
接口唯一标识
开发和调试 API
概述
生成请求
发送请求
请求历史
接口用例
动态值
校验响应
文档模式/调试模式
生成代码
环境和变量
概述
全局/环境/临时变量
环境管理
Vault Secrets(密钥库)
功能简介
前后置操作&脚本
概述
断言
提取变量
等待时间
数据库操作
概述
MySQL
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 平台集成
Git 提交自动触发测试
发布 API 文档
概述
快捷分享
查看 API 文档
发布文档站
页面布局设置
自定义页面代码
自定义域名
AI 相关特性
SEO 设置
高级设置
文档站搜索设置
跨域代理
文档站接入 Google Analytics
文档左侧目录 设置
文档可见性设置
在线 URL 链接规范
API 版本
功能简介
创建 API 版本
发布 API 版本
快捷分享 API 版本
迭代分支
功能简介
新建迭代分支
在迭代分支中改动 API
在迭代分支中测试 API
合并迭代分支
管理迭代分支
管理中心
入驻清单
了解基本概念
团队入驻
管理团队
成员角色与权限设置
团队基本操作
团队成员管理
团队资源
通用 Runner
请求代理 Agent
团队变量
实时协作
团队协作
管理项目
项目基本操作
项目成员管理
通知设置
功能简介
通知对象
通知事件
项目资源
数据库连接
管理组织
单点登录(SSO)
功能简介
为组织配置单点登录
管理用户账号
将组映射到团队
Microsoft Entra ID
SCIM 用户管理
功能简介
Microsoft Entra ID
组织资源
自托管 Runner
IDEA 插件
快速上手
生成接口文档
生成数据模型
配置
全局配置
项目内配置
可配置规则
脚本工具
Groovy 本地扩展
进阶配置
注释规范说明
框架支持
常见问题
常见问题
浏览器扩展
Chrome
Microsoft Edge
Apifox AI 功能
总览
启用 AI 功能
修改数据模型
常见问题
Apifox MCP Server
概述
通过 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
动态值表达式
常见问题
鉴权组件
复制页面
使用鉴权组件
在目录级别配置鉴权组件
#
1
选择任意一个目录,点击右侧 “Auth” 选项卡,选择鉴权方式为 “鉴权组件”。
2
从 “鉴权组件” 下拉菜单中选择需要的鉴权组件。
3
如果选择了 OAuth 2.0 鉴权组件,可以进一步选择所需的 Scope。
目录配置的鉴权组件将应用于该目录下的所有子目录和接口(除非它们有自己的鉴权配置)。
在接口级别配置鉴权组件
#
1
选择任意一个接口,点击右侧 “修改接口” 选项卡,在 “请求参数” 的 “Auth” 选项中选择鉴权方式为 “鉴权组件”。
2
从 “鉴权组件” 下拉菜单中选择需要的鉴权组件。
3
如果选择了 OAuth 2.0 鉴权组件,可以进一步选择所需的 Scope。
接口级别的鉴权配置优先级高于目录级别。
配置鉴权组件默认值
#
鉴权组件只定义了鉴权的方法,调试接口时还需要输入具体的鉴权值。
调试接口时,每次都填写鉴权值较为麻烦。因此,Apifox 提供“默认鉴权值”功能,配置默认鉴权值之后,调试接口时就可以选择使用默认鉴权值,也可以手动填写新的鉴权值。如果在目录配置了“默认鉴权值”,那么目录下的接口都可以使用这个值,非常便利。
1
在鉴权组件列表中,选择组件并配置默认值。
2
根据鉴权类型填写相应的值
API Key:填写密钥值
Basic Auth:填写用户名和密码
Bearer Token:填写令牌
OAuth 2.0:填写客户端 ID、客户端密钥等
其它鉴权类型默认值...
继承与自定义鉴权值
#
使用鉴权组件时,你可以选择:
1.
继承上级配置
:使用父级目录或根目录配置的鉴权组件及其默认值
2.
自定义鉴权值
:保持鉴权组件不变,但使用自定义的认证值
多个鉴权组件的使用
#
Apifox 支持为一个接口配置多个鉴权组件,这对应于 OpenAPI 规范中的多重认证机制:
AND 关系
:必须同时满足所有鉴权要求
OR 关系
:满足任一鉴权要求即可
在接口或目录的鉴权设置中,可以通过
+
按钮添加多个组件。
使用组合型鉴权组件
#
组合型鉴权组件创建完成后,会出现在项目的 “鉴权组件” 列表中。可以在接口或目录的 Auth 配置中引用该组合型鉴权组件,从而实现多层鉴权。
1
在项目中找到需要配置鉴权的接口或者目录,进入编辑页面。
2
在接口或目录的 Auth 配置区域,选择创建的组合型鉴权组件,Apifox 会自动应用组合型鉴权组件中的所有鉴权规则。
3
在接口测试页面,可以看到组合型鉴权组件的基本认证信息。
使用 OAuth 2.0 组件时,选择 Scope
#
根据 OpenAPI 规范,创建 OAuth 2.0 类型的鉴权组件时,需要预先配置全部 Scope。而在接口使用 OAuth 2.0 类型的鉴权组件时,需要选择使用哪些 Scope。
Apifox 为了简化接口配置 Scope 的操作,支持在目录上配置 Scope。配置之后,目录内的接口就会默认使用目录上配置的 Scope。当然,也支持为接口单独配置 Scope。
1
在接口的 “Auth” 设置中选择 OAuth 2.0 鉴权组件。
2
在 “Scopes” 配置部分,可以看到该组件定义的所有可用 Scope,选择该接口需要的 Scope。
3
如果接口继承了父级目录的 OAuth 2.0 配置,也可以点击 “Reset...” 恢复为父级配置的 Scope。
调试使用 OAuth 2.0 鉴权组件的接口
#
在进行 API 设计时,可以为使用 OAuth 2.0 的接口预先配置默认鉴权值。这样的话,调试接口时就可以直接使用默认鉴权值,而无需为每个接口都获取 Token。
在“目录”中获取 Token 作为默认鉴权值
#
1
在项目中选择一个目录,点击右侧 “Auth” 选项卡,选择 OAuth 2.0 鉴权组件,配置所需 Scopes,选择授权类型,点击 “获取 Token” 按钮。
2
在弹出的测试面板中:
填写客户端 ID、密钥等必要信息
点击 “继续” 按钮
3
获取到 Token 后,可以查看 Token 详情和有效期,获取的 Token 可用于该目录下的所有接口测试。
在“修改接口”中获取 Token 作为默认鉴权值
#
1
选择需要编辑的接口,点击 “修改接口”,选择并配置 OAuth 2.0 鉴权组件,在配置界面中点击 “获取 Token” 按钮。
2
在弹出的测试面板中:
填写客户端 ID、密钥等必要信息
点击 “继续” 按钮
3
完成授权流程获取 Token
获取的 Token 将应用于当前接口的调试
调试接口时,使用默认鉴权值或者获取新的 Token
#
方式一:使用接口默认鉴权值
运行接口时,在 “Auth” 选项卡选择 “使用接口默认鉴权值”,在接口中获取的 Token 会自动应用于当前请求。
方式二:获取新的 Token
1
运行接口时,在 “Auth” 选项卡选择 “手动设置”,点击 “获取 Token” 获取新 Token。
2
在弹出的测试面板中:
填写客户端 ID、密钥等必要信息
点击 “继续” 按钮
3
完成授权流程获取 Token
获取的 Token 将应用于当前接口的调试
上一页
创建鉴权组件
下一页
在线文档中的鉴权组件