Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. Apifox MCP Server
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 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(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • 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 平台集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • SEO 设置
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
  • 账号&应用设置
    • 账号设置
    • 语言设置
    • 网络代理
    • 快捷键
    • 数据备份与恢复
    • 更新 Apifox
    • API 访问令牌
  • 身份验证 & 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 MCP Server

通过 MCP 使用 OpenAPI/Swagger 文档

除了 Apifox 项目、在线文档之外,Apifox MCP Server 可以直接读取 Swagger/OpenAPI 文件,将内容提供给 AI 使用。

配置 MCP 客户端#

前置条件#

已安装 Node.js 环境(版本号 >= 18,推荐最新的 LTS 版本)
任意一个支持 MCP 的 IDE:
Cursor
VSCode + Cline 插件
其它

基本步骤#

1
准备 OpenAPI 文件
确保你有 Swagger/OpenAPI 文件的 URL 或本地路径
支持的格式:JSON 或 YAML 格式的 OpenAPI 文件
2
在 IDE 中配置 MCP
将下面 JSON 配置添加到 IDE 对应的 MCP 配置文件里:
macOS / Linux
Windows
{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}
其中 <oas-url-or-path> 可以是:
远程 URL,如:https://petstore.swagger.io/v2/swagger.json
本地文件路径,如:~/data/petstore/swagger.json

在 Cursor 中配置 MCP#

1
编辑 MCP 配置文件
打开 Cursor 编辑器,点击右上角 「设置」图标,选择左侧「MCP」选项,点击「+ Add new global MCP server」按钮。
CleanShot 2025-03-26 at 12.07.53@2x.png
2
添加配置内容
在打开的 mcp.json 文件中添加以下配置,注意替换 https://petstore.swagger.io/v2/swagger.json 为你的 OpenAPI 文件路径或 URL:
macOS / Linux
Windows
{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}
3
验证配置
配置完成后,你可以通过向 AI 询问以验证连接是否正常工作(Agent 模式),例如:
请通过 MCP 获取 API 文档,并告诉我项目中有几个接口
如果 AI 能够返回你 OpenAPI 规范中的 API 信息,说明连接成功。
CleanShot 2025-03-26 at 14.45.07@2x.png

在 Cline 中配置 MCP#

1
安装 Cline 插件
在 VSCode 扩展市场搜索并安装 “Cline” 插件
2
配置 MCP 服务器
打开 Cline 面板,点击 「MCP Servers > Configure MCP Servers」。
CleanShot 2025-03-26 at 12.14.20@2x.png
在打开的 .json 文件中添加以下配置,注意替换 <oas-url-or-path> 为你的 OpenAPI 文件路径或 URL:
macOS / Linux
Windows
{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}
3
验证配置
配置完成后,你可以通过向 AI 询问以验证连接是否正常工作,例如:
请通过 MCP 获取 API 文档,并告诉我项目中有几个接口
如果 AI 能够返回你 OpenAPI 规范中的 API 信息,说明连接成功。
CleanShot 2025-03-26 at 14.47.56@2x.png

在 Trae 中配置 MCP#

1
编辑 MCP 配置文件
打开最新版 Trae 编辑器,点击右上角 「AI 侧栏 -> 设置」图标,选择「MCP」选项,点击「+ 添加 MCP Servers」按钮。
CleanShot 2025-04-24 at 11.44.50@2x.png
然后在 MCP 市场中选择 “手动配置”。
CleanShot 2025-04-24 at 11.48.56@2x.png
2
添加配置内容
在打开的 .json 文件中添加以下配置,注意替换 <oas-url-or-path> 为你的 OpenAPI 文件路径或 URL:
macOS / Linux
Windows
{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}
3
验证配置
配置完成后,你可以通过向 AI 询问以验证连接是否正常工作(智能体模式),例如:
请通过 MCP 获取 API 文档,并告诉我项目中有几个接口
如果 AI 能够返回你 Apifox 项目中的 API 信息,说明连接成功。
CleanShot 2025-04-24 at 14.47.56@2x.png

注意事项#

如果需要使用多个 OpenAPI 规范文件,可以在配置文件中添加多个 MCP Server,每个使用不同的 --oas 参数值。
对于本地文件路径,确保路径正确且文件存在。对于 URL,确保 URL 可以公开访问且返回有效的 OpenAPI 规范文件。
如果你的 OpenAPI 规范文件较大或包含复杂的数据结构,MCP 服务器可能需要更多时间来处理。
使用私有化部署版本的用户,请在 IDE 的 MCP 的配置文件添加参数:"--apifox-api-base-url=<私有化部署服务器的 API 地址,以 http:// 或 https:// 开头>"。另外,请确保网络可以正常访问 www.npm.com。
{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=<oas-url-or-path>",
        // 私有化部署必须添加以下参数
        "--apifox-api-base-url=<私有化部署服务器的API地址>"
      ]
    }
  }
}

其他使用方法#

通过 MCP 使用 Apifox 项目内的 API 文档
通过 MCP 使用公开发布的 API 文档

常见问题#

Windows 系统配置问题
如果在 Windows 操作系统上,前述配置无法正常工作,请使用以下配置:
{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}
Node.js 版本问题
上一页
通过 MCP 使用公开发布的 API 文档
下一页
概述
Built with