Apifox 帮助文档
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
服务与隐私协议
复制页面
帮助中心
更新日志
入门
产品介绍
联系我们
私有化部署
开始使用
下载 Apifox
注册与登录
页面布局
基本概念
快速上手
概述
新建接口
发送接口请求
快捷请求
添加断言
新建测试场景
分享 API 文档
了解更多
导入导出数据
概述
手动导入
定时导入(绑定数据源)
导入设置
导出数据
其它方式导入
导入 OpenAPI/Swagger
导入 Postman
导入 Apipost
导入 Eolink
导入 cURL
导入 Markdown
导入 Insomnia
导入 apiDoc
导入 .har 文件
导入 knife4j
导入 NEI
导入小幺鸡(docway)
导入 Apizza
导入 WSDL
设计 API
概述
新建 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
数据模型
高级数据类型
构建数据模型
概述
通过 JSON 等生成
新建数据模型
数据模型进阶
使用 oneOf / anyOf / allOf 构建组合模式
使用 discriminator 实现多态数据结构
鉴权组件
概述
创建鉴权组件
使用鉴权组件
在线文档中的鉴权组件
高级功能
接口字段
接口状态
关联测试场景
参数列表外观
接口唯一标识
开发和调试 API
概述
生成请求
发送请求
请求历史
接口调试用例
接口测试用例
动态值
校验响应
文档模式/调试模式
生成代码
环境和变量
概述
环境管理
全局/环境/模块/临时变量
Vault Secrets(密钥库)
功能简介
前后置操作&脚本
概述
断言
提取变量
等待时间
数据库操作
概述
MySQL
MongoDB
Redis
Oracle
使用脚本
概述
前置脚本
后置脚本
公共脚本
pm 脚本 API
使用 JS 类库
响应数据可视化
调用外部程序
脚本示例
断言示例
脚本使用变量
脚本读取/修改接口请求信息
常见问题
如何获取动态参数的真实值并加密?
脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
API 调试
GraphQL 调试
WebSocket 调试
Socket.IO 调试
SSE 调试
SOAP/WebService
gRPC 调试
Webhook 调试
使用请求代理调试
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(Proxy)
团队变量
实时协作
团队协作
管理项目
项目基本操作
项目成员管理
通知设置
功能简介
通知对象
通知事件
项目资源
数据库连接
Git 仓库连接
管理组织
组织基本操作
单点登录(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 官网
私有化部署
开发者中心
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
服务与隐私协议
复制页面
隐私协议
广州睿狐科技有限公司及/或其关联方(以下简称“睿狐科技”、“我们”)尊重并保护个人信息,并且将以高度勤勉和审慎的义务对待这些信息。在您访问和使用 Apifox 以及睿狐科技提供的其他服务时,我们将按照本隐私协议(以下简称“本协议”)收集、处理及披露您的信息。我们希望通过本协议向您清晰地介绍我们对您信息的处理方式,以帮助您了解维护自己隐私权的方式。
在接受本协议之前,请您仔细阅读全部内容,如您无法准确理解或不同意本协议的任一内容,请不要访问、使用 Apifox 或睿狐科技提供的其他任何服务。
您通过网络页面点击确认、实际使用 Apifox 服务或睿狐科技所提供的其他服务等操作均表示您已阅读并充分理解本协议之内容,受其约束。
本协议属于
《Apifox 服务协议》
不可分割的一部分。您同意《Apifox 服务协议》,即视为您已经同意本协议的全部内容。
1. 本协议的适用范围
#
当您使用我们的任何产品和服务时,本协议即适用,无论该产品和服务是否单独设置了隐私协议,也无论您是浏览用户(访客)还是注册登录用户。请您注意,本协议不适用于以下情况:
✦ 通过我们的产品和/或服务而接入的第三方服务(包括任何第三方网站)收集的信息;
✦ 通过在我们产品和/或服务中进行广告服务的其他公司或机构所收集的信息。请您知悉:如果您浏览第三方网站或使用第三方的产品和/或服务时向该第三方提供您的个人信息,您的信息应当适用该第三方的隐私声明或类似协议,我们对任何第三方不当使用或披露由您提供的信息不承担任何法律责任,无论您登录或浏览上述网站、软件,或使用其产品和/或服务是否基于睿狐科技的链接或引导。强烈建议您在使用上述第三方服务前先行了解、确认服务提供方的隐私保护情况。
2. 我们如何收集您的个人隐私信息
#
2.1 您在使用 Apifox 服务时主动提供的信息,包含:您在注册或使用服务时主动填写或上传的用户名、姓名、邮箱、手机号码、头像、图片、文档等。
2.2 在您使用服务时, Apifox 可能会自动收集信息,包含:设备信息,例如设备型号、操作系统版本、设备设置、设备环境、软件的版本号、浏览器类型、客户端的 IP 地址等。
2.3 为完成服务订单支付,您可以通过银行转账、睿狐科技合作的第三方支付平台(支付宝或其他第三方支付平台,如涉及)进行支付结算,Apifox 可能会将您的用户名、对应的第三方支付平台账户名、订单支付相关信息、订单安全相关设备信息及其他反洗钱法律要求的必要信息通过在网站或移动平台中嵌入的第三方支付平台软件工具开发包(SDK)等方式与第三方支付平台共享,前述第三方支付平台可能将获得您连接网络的权限、设备信息权限,并获取网络状态和 Wi-Fi 状态。
3. 我们如何使用您的个人隐私信息
#
睿狐科技严格遵守法律法规,所收集的信息仅用于以下用途:
向您提供服务;
满足您的个性化需求,例如位置设定、个性化的帮助服务;
产品开发和服务优化,例如当睿狐科技的系统发生故障时,睿狐科技会记录和分析系统故障时产生的信息,优化睿狐科技的服务;
安全保障,例如睿狐科技会将您的信息用于身份验证、安全防范、反诈骗监测、存档备份、客户的安全服务等用途;
邀请您参与有关 Apifox 的调查。
4. 我们如何共享、转让、公开披露您的个人信息
#
4.1 出于对业务运营进行相关审计需要、相关运营需要以及法规要求,如实名身份认证、邮件、短信、咨询的推送或通知,需要雇用第三方服务商提供相应的服务,睿狐科技可能需要将您的企业 / 团队或个人的信息与这些公司共享,睿狐科技会要求服务提供商按照睿狐科技的说明、隐私政策以及其他相关的保密和安全措施来提供服务。除此之外,未经您的同意,睿狐科技不会与第三方分享任何您的个人信息。
4.2 随着睿狐科技业务的持续发展,当发生合并、收购、资产转让等交易导致向第三方分享您的个人信息时,睿狐科技将通过推送通知、公告等形式告知您相关情形,按照法律法规及不低于本政策所要求的标准继续保护或要求新的管理者继续保护您的个人信息。睿狐科技收集的信息被视作一项资产。如果睿狐科技或睿狐科技任何附属公司、部门或部分资产被另一家公司收购,则此类信息可能成为被转让资产之一。如果情况如此,收购方公司只能按照此隐私策略(或者向您收集信息时有效的后续策略)使用您的信息。
4.3 睿狐科技可能基于以下目的披露您的个人信息:
遵守适用的法律法规等有关规定;
遵守法院判决、裁定或其他法律程序的规定;
遵守相关政府机关或其他法定授权组织的要求;
睿狐 科技有理由确信需要遵守法律法规等有关规定;
为执行相关服务协议或本政策、维护社会公共利益,为保护睿狐科技的客户、睿狐科技或睿狐科技的关联公司、其他用户或雇员的人身财产安全或其他合法权益合理且必要的用途。
5. 我们如何保护您的个人信息
#
您的个人信息安全对于我们至关重要。我们将严格遵守相关法律法规,采取业内认可的合理可行的措施,保护您的个人信息。防止信息遭到未经授权的访问、披露、使用、修改,避免信息损坏或丢失。
5.1 技术措施与数据安全措施
我们努力采取各种符合业界标准的物理、电子和管理方面的安全措施来保护您的个人信息安全。我们积极建立数据分类分级制度、数据安全管理规范、数据安全开发规范来管理规范个人信息的存储和使用,确保未收集与我们提供的服务无关的个人信息。
我们通过与信息接触者签署保密协议、监控和审计机制来对数据进行全面安全控制。防止您的个人信息遭到未经授权的访问、公开披露、使用、修改、损坏或丢失。
我们已使用符合业界标准的安全防护措施保护您提供的个人信息,防止数据遭到未经授权的访问、公开披露、使用、修改,防止数据发生损坏或丢失。我们会采取一切合理可行的措施,保护您的个人信息。例如,在您的浏览器与 Apifox之间交换数据(如信用卡信息)时受 SSL 加密保护;我们同时提供 https 安全浏览方式;我们会使用加密技术确保数据的保密性;我们会使用受信赖的保护机制防止数据遭到恶意攻击;我们会部署访问控制机制,确保只有授权人员才可以访问个人信息;以及我们会举办安全和隐私保护培训课程,加强员工对于保护个人信息重要性的认识。
5.2 安全事件处置
我们将尽力确保您发送给我们的任何信息的安全性,但请您理解,由于技术的限制以及在互联网行业存在的各种恶意手段,不始终保证信息百分之百的安全。您需要了解,您接入我们服务所用的系统和通讯网络,有因我们可控范围外的因素而出现问题。为防止安全事故的发生,我们制定了妥善的预警机制和应急预案。若不幸发生个人信息安全事件,我们将按照法律法规的要求,及时向您告知:安全事件的基本情况和的影响、我们已采取或将要采取的处置措施、您可自主防范和降低风险的建议和对您的补救措施,并立即启动应急预案,力求将损失最小化。我们将及时将事件相关情况以电话、推送通知等方式告知您,难以逐一告知用户时,我们会采取合理、有效的方式发布公告。同时,我们还将按照监管部门要求,主动上报个人信息安全事件的处置情况,紧密配合政府机关的工作。
6. 您管理个人信息的方式
#
您在使用服务期间可以管理自己的信息。您可以在使用 Apifox 服务的过程中,访问、修改和删除您提供的注册信息和其他个人信息,也可按照通知指引与睿狐科技联系。您访问、修改和删除个人信息的范围和方式将取决于您使用的具体服务。在您访问、修改和删除相关信息时,睿狐科技可能会要求您进行身份验证,以保障帐号的安全。睿狐科技将按照本政策所述,仅为实现睿狐科技产品或服务的功能,收集、使用您的信息。如您发现睿狐科技违反法律、行政法规的规定或者双方的约定收集、使用您的个人信息,您可以要求睿狐科技删除。如您发现睿狐科技收集、存储的您的个人信息有错误的,您可以要求睿狐科技更正。
您需要对您主动分享的信息负责。您可以通过 Apifox 的服务与您的同事、团队成员等其他用户分享您的相关信息,例如您的文档、上传的文件等。请注意,这其中可能包含您的个人身份信息、个人财产信息、公司财务信息等敏感信息,请您谨慎考虑披露您个人及公司的敏感信息。您可以通过 Apifox 的设置功能或睿狐科技提供的指引删除您公开分享的信息。但请您注意,这些信息仍可能由其他用户或不受睿狐科技控制的非关联第三方独立地保存。
7. 您个人信息的存储
#
我们将从中华人民共和国境内获得的信息存放于中华人民共和国境内。如果发生数据的跨境传输,我们会单独向您以弹窗或邮件的方式告知您数据出境的目的、接收方等,并征得您的授权同意,我们会确保数据接收方有充足的数据保护能力来保护您的个人信息。我们承诺您个人信息的存储时间始终处于合理必要期限内。
8. Cookie 和 SDK 的使用
#
Apifox 会使用 Cookie 及相关技术。Apifox 或 Apifox 的第三方合作伙伴,可能通过放置安全的 Cookie 及相关技术收集您的信息,目的是为您提供更个性化的用户体验和服务。睿狐科技会严格要求第三方合作伙伴遵守本政策的相关规定。您也可以通过浏览器设置管理 Cookie。但请注意,如果停用 Cookie, 您就不能使用 Apifox 的各项交互功能。
SDK 的使用:为保障 Apifox 相关功能的实现和稳定运行,使您能够使用和享受更多的服务及功能, Apifox 中会嵌入第三方合作伙伴的 SDK 或由第三方合作伙伴的 SDK 直接提供相关服务。Apifox 会对第三方合作伙伴获取有关信息的 SDK 进行严格的安全检测,并与第三方合作伙伴约定严格的数据保护措施,令其按照本政策以及其他任何相关的保密和安全措施来处理个人信息。
9. 我们如何处理未成年人的个人信息
#
9.1 我们主要面向成人提供产品和服务。如果没有父母或监护人的同意,未成年人不得创建自己的用户账户。如您为未成年人,我们要求您请您的父母或监护人仔细阅读本协议,并在征得您的父母或监护人同意的前提下使用我们的服务或向我们提供信息。
9.2 对于经父母或监护人同意使用我们的产品或服务而收集未成年人个人信息的情况,我们只会在法律法规允许、父母或监护人明确同意或者保护未成年人所必要的情况下使用、共享、转让或披露此信息。
9.3 尽管当地法律和 习俗对未成年人的定义不同,但我们将不满 14 周岁的任何人均视为未成年人。
9.4 如果我们发现自己在未事先获得可证实的父母同意的情况下收集了未成年人的个人信息,则会设法尽快删除相关数据。
10. 您的个人信息如何在全球范围转移
#
10.1 我们在中华人民共和国境内运营中收集和产生的个人信息,存储在中国境内,以下情形除外:
法律法规有明确规定;
获得您的明确授权;
您通过互联网进行跨境交易等个人主动行为。
针对以上情形,我们会确保依据本协议对您的个人信息提供足够的保护。
10.2 由于我们通过遍布全球的资源和服务器提供产品或服务,这意味着,获得您的授权同意后,您的个人信息可能会被转 移到您使用产品或服务所在国家/地区的境外管辖区,或者受到来自这些管辖区的访问。
10.3 此类管辖区可能设有不同的数据保护法,甚至未设立相关法律。在此类情况下,我们会确保您的个人信息得到在中华人民共和国境内足够同等的保护。例如,我们会请求您对跨境转移个人信息的同意,或者在跨境数据转移之前实施数据去标识化等安全举措。
11. 本协议如何更新
#
11.1 我们的隐私协议可能变更。
11.2 未经您明确同意,我们不会削减您按照本协议所应享有的权利。我们会在专门页面上发布对隐私协议所做的任何变更。
11.3 对于重大变更,我们还会提供更为显著的通知(包括对于某些服务,我们会通过网站公示的方式进行通知甚至向您提供弹窗提示,说明隐私权协议的具体变更内容),并会在变更生效前给您预留合理的期限供您考虑是否接受变更。若您在新版本隐私协议和用户协议生效后继续使用我们的产品和服务,即表示您已充分阅读并愿意受更新后的隐私协议和用户协议约束,若您不同意该等变更可以停止使用我们的产品和服务。
11.4 本协议所指的重大变更包括但不限于:
我们的服务模式发生重大变化。如处理个人信息的目的、处理的个人信息类型、个人信息的使 用方式等;
我们在所有权结构、组织架构等方面发生重大变化。如业务调整、破产并购等引起的所有者变更等;
个人信息共享、转让或公开披露的主要对象发生变化;
您参与个人信息处理方面的权利及其行使方式发生重大变化;
我们负责处理个人信息安全的责任部门、联络方式及投诉渠道发生变化时;
个人信息安全影响评估报告表明存在高风险时。
12. 如何联系我们