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
动态值表达式
常见问题
项目资源
复制页面
数据库连接
你可以在项目设置中,配置数据库的连接信息。配置完成后,在接口调试、测试时,前后置操作中可以添加
数据库操作
并引用此处配置的数据库连接信息,从而实现读写数据库数据。
Apifox 免费版支持连接以下类型的数据库:
MySQL
SQL Server:支持 SQL Server 2014 以上版本
Oracle(连接 Oracle 数据库需要单独安装
Oracle Client
)
Db2
PostgreSQL
ClickHouse
MongoDB
升级到商业标准版后,可以额外连接 Redis;升级到商业专业版后,可以额外连接达梦数据库。
配置数据库连接
#
在 Apifox 中设置数据库连接的步骤如下:
1
打开 “项目设置 -> 数据库连接”。
2
点击右上角的 “新建” 来创建数据库连接。
3
从可用选项中选择数据库类型,填写必要的连接信息,比如数据库地址、端口、数据库名、用户名和密码。推荐使用
变量
填入,完全以变量形式填入的数据库连接,可以保存在云端用以协同。
📌
重要!
使用变量来配置数据库链接,需注意
数据安全问题
。
4
除了用户名密码的本地连接方式,你还可以通过 SSH 隧道建立更安全的连接,更好地保护数据传输。
5
点击 “保存”,这个连接就可以在前置和后置操作中使用了。
使用数据库连接
#
可以在接口请求的前后置操作中,添加 “数据库操作” 来引用数据库连接进行使用,添加之后可以在 “数据库操作” 中指定一个数据库连接。
下面是数据库操作的具体步骤。
1
在运行标签页
(文档模式)
或请求标签页
(调试模式)
中,导航到后置操作。
2
鼠标光标悬停在 “添加后置操作” 上并选择 “数据库操作”。
3
为数据库操作命名并设置数据库连接,需要确保选择的 “数据库连接” 实际数据已被正确配置。
了解更多
4
输入 SQL 命令。命令中支持使用变量,如
{{variables}}
。
5
设置 “提取结果到变量”,支持使用 JSONPath,开启 “控制台打印结果” 开关。
6
点击发送请求,你可以在控制台查看数据库操作的结果。
如果在自动化测试中使用了 “数据库操作” 步骤,或者在接口请求的前后置操作中使用了 “数据库操作”,也可以按照上述方式进 行使用。
Apifox 支持标准 SQL 查询,但不支持存储过程这类复杂的 SQL 操作。
注意事项
#
在发送请求执行数据库操作前,需确认所配置的数据库连接信息已正确保存:
如果是保存在云端、使用了变量的数据库连接,请在相关变量的 “本地值” 中设置好实际的数据库地址、用户名、密码等连接内容,或通过 set 变量方式设置实际连接内容。
如果是保存在本地、使用了固定文本的数据库连接,请在 “项目设置 -> 数据库连接” 中,填入固定文本的 实际数据库地址、用户名、密码等连接内容。
如果需要通过
CLI
运行带数据库连接的测试场景,则
在此了解详细注意事项
;
如果需要通过
Runner
运行带数据库连接的测试场景,则
在此了解详细注意事项
。
保存机制与数据安全
#
目前 Apifox 的数据库连接保存方式有两种:
保存于 Apifox 云端
。通过在数据库连接中,完全使用变量方式填写,则此条数据库连接的内容会以变量形式保存于 Apifox 云端服务器中。
保存于当前配置者本地
。通过在数据库连接中,完全使用固定文本方式填写,则此条数据库连接的内容会以明文形式保存于当前配置者的本地文件内。
关于此两种保存机制的区别:
保存机制
保存方法
优点
缺点
云端
配置时使用变量
1.
更方便与其他成员协同使用
2.
通过 CI、Runner 等方式运行测试场景时可以通过变量 set 数据库连接内容,而非维护专门的本地文件
当在变量远程值中使用明文时,数据库名、密码等数据会被明文传输至 Apifox 云端服务器,有数据安全风险(使用变量本地值则仍然保存在本地,无风险)。建议使用
Vault 变量
来避免数据安全风险
本地
配置时使用固定文本
本地独立保存,没有数据安全风险
1.
不好协同,每个成员均要在数据库连接中自行配置数据
2.
通过 CI、Runner 等方式运行测试场景时需要通过维护专门的数据库连接本地文件
💡
为了获得良好使用体验与数据安全的平衡,Apifox 推荐以云端保存方式维护数据库连接,并使用 Vault 变量确保数据安全。
极其不建议
在数据库连接的相关
变量远程值中使用明文
,可能造成数据安全风险。
了解更多
#
MySQL 数据库操作
MongoDB 数据库操作
Redis 数据库操作
Oracle 数据库操作
上一页
通知事件
下一页
功能简介