Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
更多
    1. 管理团队
    • 帮助中心
    • 更新日志
    • 入门
      • 产品介绍
      • 联系我们
      • 私有化部署
    • 开始使用
      • 下载 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. 管理团队

    成员角色与权限设置

    给团队或项目成员设置权限的步骤:
    1
    打开 “Apifox 主窗口 -> 我的团队”,然后点击 “成员/权限”。
    2
    找到要设置的成员名字,点击旁边的齿轮图标 ⚙️。
    3
    给这个成员选择合适的权限级别。
    image.png
    成员的角色和权限分为两大类:团队权限和项目权限。

    团队角色与权限#

    默认团队角色与权限#

    团队层级权限按角色分为:团队所有者、团队管理员、团队成员、游客。对应的角色权限如下:
    资源分类资源名称功能团队所有者团队管理员团队成员游客
    团队管理
    成员/角色
    团队成员查看
    ✅
    ✅
    ✅
    ❌
    团队成员邀请
    ✅
    ✅
    ❌
    ❌
    团队成员角色设置/移除
    ✅
    ✅
    ❌
    ❌
    项目角色查看
    ✅
    ✅
    ❌
    ❌
    项目角色增删改
    ✅
    ✅
    ❌
    ❌
    团队设置
    修改团队名称
    ✅
    ✅
    ❌
    ❌
    移交团队
    ✅
    ❌
    ❌
    ❌
    解散团队
    ✅
    ❌
    ❌
    ❌
    项目操作
    新建
    ✅
    ✅
    ❌
    ❌
    克隆
    ✅
    ✅
    ❌
    ❌
    删除/转移
    ✅
    ✅
    ❌
    ❌
    修改名称
    ✅
    ✅
    ❌
    ❌
    团队角色目前不支持自定义权限。
    通过项目邀请获得项目权限的用户,在团队维度的权限就是游客。
    游客只能看到受到邀请的项目。如果你想要让外部协作者编辑相关项目,但又不想让他介入团队内的其他项目,可以使用 “项目邀请”。
    游客在团队权限上与团队成员一致。不同的地方在于,团队内的新建项目,在权限设置时,是排除游客角色的。

    如何设置团队权限#

    通过 “Apifox 主窗口 -> 我的团队 -> 成员/权限 -> 团队权限” 为成员设置团队层级权限。

    项目角色与权限#

    默认项目角色与权限#

    项目角色分为四种类型:管理员、编辑者、只读成员、禁止访问,此四种为 Apifox 内置项目角色。其中:
    管理员: 可针对项目内信息、设置及数据进行增删改查;
    编辑者: 不可增删改项目、项目信息;
    只读成员: 不可对项目、数据进行增删改,只允许读取;
    禁止访问: 无法访问项目内任何信息和数据。
    一般用户直接使用内置项目角色即可满足项目权限需求,以下是内置角色的具体项目权限列表。
    资源分类资源名称功能只读成员编辑者管理员禁止访问
    分支管理
    迭代分支
    查看、切换
    ✅
    ✅
    ✅
    ❌
    合并
    ❌
    ✅
    ✅
    ❌
    查看/提交合并请求
    ❌
    ✅
    ✅
    ❌
    保护分支内容增删改、合并
    ❌
    ❌
    ✅
    ❌
    API 版本
    查看、切换
    ✅
    ✅
    ✅
    ❌
    接口管理
    接口
    包括用例、MD、WS、通用接口文档等相关资源
    查看、运行
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    生成代码
    ❌
    ✅
    ✅
    ❌
    接口用例增删改
    ❌
    ✅
    ✅
    ❌
    数据模型
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    组件库
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    快捷请求
    查看、发送
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    回收站
    查看
    ❌
    ✅
    ✅
    ❌
    恢复
    ❌
    ✅
    ✅
    ❌
    永久删除
    ❌
    ❌
    ✅
    ❌
    自动化测试
    测试场景
    查看、运行功能测试
    ✅
    ✅
    ✅
    ❌
    运行性能测试
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    导出外部程序运行
    ❌
    ✅
    ✅
    ❌
    定时任务
    查看/立即运行
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    测试报告
    删除
    ❌
    ✅
    ✅
    ❌
    环境管理
    全局变量
    查看、编辑本地值
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    全局参数
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    Vault Secrets(密钥库)
    增删改查
    ❌
    ✅
    ✅
    ❌
    环境
    查看、编辑本地值
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    分享文档
    快捷分享
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    发布文档
    查看、预览
    ✅
    ✅
    ✅
    ❌
    发布设置
    ❌
    ❌
    ✅
    ❌
    项目设置
    基本设置
    查看
    ✅
    ✅
    ✅
    ❌
    修改
    ❌
    ❌
    ✅
    ❌
    项目克隆
    ❌
    ❌
    ✅
    ❌
    成员管理
    查看
    ❌
    ❌
    ✅
    ❌
    添加
    ❌
    ❌
    ✅
    ❌
    成员角色设置/移除
    ❌
    ❌
    ✅
    ❌
    功能设置
    包括接口功能设置、响应校验设置、Mock 设置、高级设置
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ❌
    ✅
    ❌
    通知对象
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    通知事件
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    常用参数
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    迭代分支
    查看
    ✅
    ✅
    ✅
    ❌
    增删改、保护、归档、恢复
    ❌
    ✅
    ✅
    ❌
    API 版本
    查看
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    公共脚本
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    数据库连接
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    自定义函数
    查看、引用
    ✅
    ✅
    ✅
    ❌
    增删改
    ❌
    ✅
    ✅
    ❌
    导入数据
    手动导入
    ❌
    ✅
    ✅
    ❌
    定时导入手动触发
    ❌
    ✅
    ✅
    ❌
    定时导入设置
    ❌
    ❌
    ✅
    ❌
    导出数据
    导出数据
    ❌
    ✅
    ✅
    ❌
    请求历史
    本地请求历史
    查看
    ✅
    ✅
    ✅
    ❌
    分享
    ✅
    ✅
    ✅
    ❌
    共享请求历史
    查看
    ✅
    ✅
    ✅
    ❌
    删除
    ❌
    ✅
    ✅
    ❌

    自定义项目角色#

    如果 Apifox 内置项目角色不能够满足在项目权限控制相关的需求,可以使用自定义项目角色来解决这个问题。
    image.png
    需要付费版本为 “商业旗舰版” 才可使用此功能。
    在 “Apifox 主窗口 -> 成员/权限 -> 角色与权限” 管理页或 “组织 -> 成员 -> 角色与权限” 管理页,点击 “添加”,即可开始创建一个自定义项目角色。可以自由设置自定义角色的名称,然后在下面从全部的项目功能中,自由选择想要的项目功能指定给这个自定义项目角色。
    自定义项目角色
    需要特别注意的是,在某个功能模块中,最右侧的 “全部权限” 配置如果被勾选上,则代表该功能模块后续的新功能也会被默认赋予此自定义角色。
    默认角色不可被修改名称和具体的权限。可以复制 “编辑者” 或 “只读成员” 这两个默认角色,然后进行修改,从而快速创建一个新的自定义角色。

    如何设置项目权限#

    1.当你发送邀请时,可以指定邀请对象参与当前团队的特定项目,并设置他们的权限级别。
    2.也可以通过 “Apifox 主窗口 -> 我的团队 -> 成员/权限 -> 项目权限” 为成员设置项目层级权限。
    上一页
    团队入驻
    下一页
    团队基本操作
    Built with