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 提供 团队所有者、团队管理员、团队成员、游客 四种内置团队角色。为成员分配团队角色,可以控制其成员管理、团队设置和项目操作等团队级权限。
资源分类资源名称功能团队所有者团队管理员团队成员游客
团队管理成员/角色查看团队成员✅✅✅❌
邀请团队成员✅✅❌❌
设置/移除团队成员角色✅✅❌❌
查看项目角色✅✅❌❌
新增、编辑或删除项目角色✅✅❌❌
团队设置修改团队名称✅✅❌❌
移交团队✅❌❌❌
解散团队✅❌❌❌
项目操作新建项目✅✅❌❌
克隆项目✅✅❌❌
删除/转移项目✅✅❌❌
修改项目名称✅✅❌❌
团队角色暂不支持自定义。

游客角色说明#

游客是受限的内置团队角色,适用于暂时不需要访问团队项目的成员。
团队页面:游客无法查看 我的团队 → 成员/权限 中的成员列表及角色权限内容。在团队设置中,仅保留本人 我的团队内昵称 的编辑入口。
已有项目:成员的团队角色一旦改为 游客,其在当前团队的所有已有项目会自动改为 禁止访问 状态。即使之后将该成员改为其他团队角色,原有 项目角色 也不会自动恢复,需要管理员重新分配。
新建项目:创建项目时,无论 其他成员的项目权限 选择什么角色,游客默认无法访问该新建项目。如有所需,请在项目创建后找管理员分配项目权限。
团队角色 游客 与项目访问状态 禁止访问 是不同层级概念。

设置团队角色#

团队角色可以在成员设置中调整;如果邀请页面提供团队角色配置项,也可以在发送邀请时直接设置。
给团队成员设置 团队角色 或 项目角色 的步骤:
1
打开 Apifox 主窗口 → 我的团队 → 成员/权限。
2
找到目标成员,点击其右侧的设置图标 ⚙️。
3
给这个成员选择合适的权限级别。
image.png

项目角色与权限#

默认项目角色与权限#

Apifox 提供 管理员、编辑者和只读成员 三种内置项目角色及 禁止访问 状态:
管理员:可管理项目内容、设置和数据;
编辑者:可编辑大部分项目内容和数据,但部分项目设置和高风险操作受限;
只读成员:以查看和运行为主,可以执行权限表中标记为可用的操作,但不能修改共享的项目内容和配置;
禁止访问:无法访问项目中的信息和数据。
以下是默认项目角色的详细权限列表:
资源分类资源名称功能只读成员编辑者管理员禁止访问
分支管理
迭代分支
查看、切换
✅
✅
✅
❌
合并
❌
✅
✅
❌
查看/提交合并请求
❌
✅
✅
❌
保护分支内容增删改、合并
❌
❌
✅
❌
API 版本
查看、切换
✅
✅
✅
❌
接口管理
接口
包括用例、MD、WS、通用接口文档等相关资源
查看、运行
✅
✅
✅
❌
增删改
❌
✅
✅
❌
生成代码
❌
✅
✅
❌
接口用例增删改
❌
✅
✅
❌
数据模型
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
组件库
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
快捷请求
查看、发送
✅
✅
✅
❌
增删改
❌
✅
✅
❌
回收站
查看
❌
✅
✅
❌
恢复
❌
✅
✅
❌
永久删除
❌
❌
✅
❌
自动化测试
测试场景
查看、运行功能测试
✅
✅
✅
❌
运行性能测试
✅
✅
✅
❌
增删改
❌
✅
✅
❌
导出外部程序运行
❌
✅
✅
❌
定时任务
查看/立即运行
✅
✅
✅
❌
增删改
❌
✅
✅
❌
测试报告
删除
❌
✅
✅
❌
环境管理
全局变量
查看、编辑本地值
✅
✅
✅
❌
增删改
❌
✅
✅
❌
全局参数
查看
✅
✅
✅
❌
增删改
❌
✅
✅
❌
Vault Secrets(密钥库)
增删改查
❌
✅
✅
❌
环境
查看、编辑本地值
✅
✅
✅
❌
增删改
❌
✅
✅
❌
分享文档
快捷分享
查看
✅
✅
✅
❌
增删改
❌
✅
✅
❌
发布文档
查看、预览
✅
✅
✅
❌
发布设置
❌
❌
✅
❌
项目设置
基本设置
查看
✅
✅
✅
❌
修改
❌
❌
✅
❌
项目克隆
❌
❌
✅
❌
成员管理
查看
❌
❌
✅
❌
添加
❌
❌
✅
❌
成员角色设置/移除
❌
❌
✅
❌
功能设置
包括接口功能设置、响应校验设置、Mock 设置、高级设置
查看
✅
✅
✅
❌
增删改
❌
❌
✅
❌
通知对象
查看
✅
✅
✅
❌
增删改
❌
✅
✅
❌
通知事件
查看
✅
✅
✅
❌
增删改
❌
✅
✅
❌
常用参数
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
迭代分支
查看
✅
✅
✅
❌
增删改、保护、归档、恢复
❌
✅
✅
❌
API 版本
查看
✅
✅
✅
❌
增删改
❌
✅
✅
❌
公共脚本
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
数据库连接
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
自定义函数
查看、引用
✅
✅
✅
❌
增删改
❌
✅
✅
❌
导入数据
手动导入
❌
✅
✅
❌
定时导入手动触发
❌
✅
✅
❌
定时导入设置
❌
❌
✅
❌
导出数据
导出数据
❌
✅
✅
❌
请求历史
本地请求历史
查看
✅
✅
✅
❌
分享
✅
✅
✅
❌
共享请求历史
查看
✅
✅
✅
❌
删除
❌
✅
✅
❌
项目角色既可以在邀请成员时配置,也可以在项目成员设置中调整。
了解更多:项目成员管理。

自定义角色与权限#

“角色与权限”功能可以根据不同协作场景配置更精细的角色权限。目前仅支持自定义项目角色,团队角色和组织角色暂不支持自定义。

自定义项目角色#

如果 Apifox 内置项目角色不能够满足在项目权限控制相关的需求,可以使用自定义项目角色来解决这个问题。
自定义项目角色仅在商业旗舰版中提供。
在 Apifox 主窗口 → 成员/权限 → 角色与权限,或 组织 → 成员 → 角色与权限 页面中点击“添加”,即可创建自定义项目角色。
image.png
设置角色名称后,从项目功能列表中勾选该角色可以使用的功能。
自定义项目角色
勾选某个功能模块的“全部权限”后,该模块后续新增的权限也会自动授予此角色。
默认角色的名称和权限不可修改。可以复制“编辑者”或“只读成员”,再基于副本快速创建自定义角色。

邀请时的权限配置#

邀请时可以配置哪些权限,取决于邀请入口以及邀请者拥有的团队和项目管理权限:
从团队邀请:只有团队所有者和团队管理员可以发起。邀请时可以设置受邀者的团队角色,并为全部项目统一设置项目角色,或选择“自定义”逐项目配置权限。
从项目邀请:只有当前项目的项目管理员可以发起。
如果邀请者同时是团队所有者或团队管理员,可以设置当前项目角色、团队角色和其他项目权限;
如果邀请者不具备团队管理权限,只能设置当前项目角色。
上一页
团队成员管理
下一页
通用 Runner
Built with