Apifox 帮助文档
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • Apifox Markdown
  • 更新日志
  • Road Map
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档
常见问题Apifox 官网私有化部署
开发者中心
开发者中心
  • 开放 API
  • Apifox Markdown
  • 更新日志
  • Road Map
下载
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 管理中心
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 私有化部署
    • 联系我们
  • 开始使用
    • 下载 Apifox
    • 基本概念
    • 注册与登录
    • 页面布局
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 导入导出数据
      • 导出数据
      • 手动导入
      • 概述
      • 定时导入(绑定数据源)
      • 导入设置
      • 其它方式导入
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 Apipost
        • 导入 Eolink
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
        • 导入 Postman
        • 导入 OpenAPI/Swagger
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 接口设计规范
    • 模块
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 接口评论
    • 批量管理
    • 通用接口文档
    • 基础知识
      • 接口基本信息
        • 请求头
        • 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
    • 动态值表达式
  • 常见问题
  1. 管理中心

基本概念

Apifox 提供了完善的管理能力,帮助你高效管理 API 开发流程和团队协作。Apifox 将工作空间划分为 项目、团队 和 组织 三个层级,便于按不同的管理范围精确组织资源和权限。

项目、团队和组织的区别#

在 Apifox 中,项目、团队和组织分别对应不同的管理边界。

项目#

项目 是设计、测试和管理 API 及其文档的核心工作空间。你可以在项目中创建、编辑和测试 API,设计和管理 API 文档,并与其他成员协作完成任务。
通过创建多个项目,你可以根据需求对 API 和文档进行分类,进一步提升工作效率和可维护性。每个项目都有独立的设置和权限控制,确保项目安全和数据隐私。
CleanShot 2024-12-20 at 15.40.25@2x.png
了解更多:
管理项目
管理项目成员

团队#

在 Apifox 中,团队 是管理项目和成员的基本协作单元。团队可以隶属于某个组织,也可以作为独立的工作空间使用。
使用团队可以:
隔离数据:不同团队的数据边界彼此独立。成员不会因为加入一个团队,而自动获得其他团队的资源访问权限。
控制访问:通过团队角色和项目角色,为成员分配不同范围的操作权限。
安全协作:成员可以在独立的团队空间中共享资源并协同编辑 API。
image.png
了解更多:
管理团队
管理团队成员

组织#

组织 是可选的最高级管理空间,适合需要集中管理多个团队的企业。规模较小的协作团队可以直接使用独立团队;当公司需要跨团队统一管理时,可以再创建组织。
使用组织可以:
集中管理:在统一的管理空间中查看和管理多个团队及其 API 项目。
统一权限:统一分配组织角色和管理权限,并将成员分配到不同团队。
确保合规:在不同团队之间建立明确的数据边界和隐私策略。
组织级管理权限不等同于项目访问权限。成员最终可以访问哪些团队和项目,仍取决于其团队角色和项目角色。
CleanShot 2025-02-19 at 11.43.36@2x.png
简而言之:
项目 是实际进行 API 设计、开发和测试的工作空间。
团队 为特定部门或业务线提供独立、安全的协作环境。
组织 用于在企业范围内集中管理和监督多个团队。

组织 vs. 团队 —— 该怎么选?#

在用 Apifox 的时候,很多人会纠结:到底是直接用组织来管,还是主要依靠团队?其实核心就看两个点——人数多少、业务范围有多大。
如果团队不大,业务也比较集中
比如你们就十来个人,做的也是同一个产品线,这种情况只用 团队 就够了。团队里可以管理项目、API 和成员,简单高效,不需要再加组织层。
如果规模很大,业务又分散
如果你们公司人多,业务线也五花八门,那最好先建一个 组织,再在组织里按业务划分多个 团队。每个团队只管自己的项目和成员,互不干扰,边界更清楚。

应该从哪里邀请成员?(项目、团队或组织)#

Apifox 支持从 项目、团队 和 组织 三个层级邀请成员。不同入口对应不同的成员管理范围和初始角色配置方式;成员最终可以访问哪些内容,取决于其团队角色和各项目的项目角色。
请根据实际协作场景选择邀请入口:
对比项📁 项目级邀请👥 团队级邀请🏢 组织级邀请
邀请入口进入目标项目,在 “项目设置 → 成员” 中发起邀请 image.png进入 “主窗口 → 成员/权限”,点击 “邀请” image.png进入组织管理后台,在成员页面发起邀请 image.png
适用目的邀请协作者参与指定项目,并仅配置该项目的访问权限。将成员加入某一团队,同时配置团队角色和团队内的项目权限。将人员纳入组织统一管理,集中维护组织结构和付费事项,并按需分配到相应团队。
典型场景跨部门协作或外包:对方只需要访问一个指定项目。创建新业务线或部门:对方需要参与同一团队下的多个项目。新员工入职或跨团队调配:由 HR 或 IT 管理员集中维护组织成员,再按需要将其分配到不同业务团队。
邀请后受邀者加入当前项目,并同时成为所属团队的成员;团队内其他项目的权限为 “禁止访问”。受邀者加入当前团队;可设置其 团队角色,并通过 “全部项目” 统一设置项目角色,或选择 “自定义” 逐项目配置。受邀者成为组织成员;邀请时可按需将其加入指定团队,并设置团队角色。
上一页
AI 分支
下一页
团队入驻
Built with