Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. Apifox AI 功能
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 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
    • 概述
    • 新建 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 使用公开发布的 API 文档
    • 通过 MCP 使用 Apifox 项目内的 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 AI 功能

启用 AI 功能

Apifox AI 功能是默认关闭的,你可以在 「组织 / 团队 - 资源 - AI 功能」 中,开启 AI 功能,来让组织 / 团队内的全部项目,都可以使用 AI 能力来提升效率。
需要组织 / 团队管理员及以上权限,才可以进行 AI 功能的配置。

配置 AI 供应商#

在 AI 功能开启后,即可看到 AI 模型供应商的配置入口。点击添加供应商,即可开始进行配置。
image.png
目前 Apifox 提供以下供应商来接入 AI 模型:
火山引擎
阿里云百炼
腾讯云
硅基流动
深度求索
如果以上供应商不满足你的需求,你也可以通过 “自定义 API 配置”,来接入其他供应商或本地部署的模型。
一般来说,以下内容可以由你自定义配置:
1.
API Key
调用各个供应商 AI 接口的鉴权。可以使用测试功能来看 Key 是否生效;
01-apifox-apikey.gif
2.
API 前置 URL
在 Apifox 中使用 AI 功能时,请求实际发送到的 URL。预设的供应商会自动填充通用的前置 URL,你也可以根据实际情况修改。
每次对 AI 模型的请求,均是从 Apifox 服务端发起至此 API 前置 URL。
3.
模型列表
AI 供应商提供的模型列表。如果使用 Apifox 预设的供应商,会有一些默认模型供选择。此列表中开启的模型才可在 AI 功能中被使用。如果你需要使用的模型不在此列表中,你可以使用添加模型功能来添加你需要的模型。
Apifox 相关 AI 功能,有我们预设好的 Prompt 和调用流程。如果想要 AI 功能有较好的效果,请务必选择先进、强大的模型(支持更长的上下文、function calling 等高级能力)。如 Apifox 预设提供的模型,DeepSeek-V3-0324 等。 能力较弱的模型可能会导致 Apifox AI 相关功能的使用结果不符预期。
4.
API 格式
在 “自定义 API 配置” 中可以调整,影响自定义 API 请求与响应的格式使用,选择不正确可能会导致 API 调用失败。一般来说,大多数模型都支持 OpenAI 格式。

设置默认模型#

当在 AI 功能中没有指定使用哪个模型时,功能默认使用的模型即为此处指定的模型。下拉可选项,是模型供应商中设置启用的具体模型。你可根据实际需求指定某个模型作为整个组织 / 团队中 AI 功能使用的默认模型。
image.png
默认模型会默认使用 “自动选择” 模型,其逻辑为根据启用供应商及启用模型的顺序,自动选中一个有效模型进行使用。
如果你在默认模型中指定了某个具体模型(例如设置了阿里云百炼的 DeepSeek V3 模型),如果此模型或所属供应商被停用 / 删除,则默认模型会重置为 “自动选择”。

功能 & 提示词#

所有 Apifox AI 功能,都可以由此处进行功能入口的控制与提示词的调整。相关 AI 功能的开关打开后,在项目中的对应位置才可看到功能入口;可以查看 Apifox 预设的提示词,并根据自己的实际情况,对提示词进行调整,让 AI 能够输出更符合实际需求的数据。
image.png
提示词调整功能目前暂未开放,敬请期待。

从组织中继承 AI 配置到团队#

如果你使用到了组织功能,则可以让组织的管理员、所有者在组织层级配置 AI 功能。这样在组织下的全部团队,都可继承使用组织中已经配好的相关 AI 配置,并且团队中的配置会受到组织中配置的管控,用以更好的控制整个组织对 AI 功能的使用。
在组织的「资源 - AI 功能」中,同样有配置的界面,可以进行跟上述团队配置 AI 供应商一样的操作。
CleanShot 2025-06-25 at 11.09.39@2x.png
在组织中配置好 AI 功能后,组织下的全部团队均可继承来自组织的 AI 供应商、默认模型、功能配置。
image.png
组织下团队继承的特点:
1.
所有开关(AI 功能整体开关、供应商开关、模型开关、具体功能开关),均会继承组织级别的配置。如果组织级开启,则组织下团队的对应开关可以选择开启或关闭;如果组织级关闭,则组织下团队的对应开关直接禁用。这样是为了更好的适配从组织级对 AI 功能的整体管理需求。
image.png
2.
模型供应商可以选择继承自组织,也可以选择自定义来根据团队的实际情况自己配置。
image.png
3.
默认模型配置同样可以选择继承组织配置的供应商,也可以团队自己独立设置有效的模型。
image.png
上一页
总览
下一页
修改数据模型
Built with