一分钟,让你的 API 文档支持 MCP 使用,Apifox 新功能上线!!!

781 阅读5分钟

一直以来,Apifox 都提倡 API 设计先行这一理念:先定义好 API 文档,然后开发、调试、自动化测试都可以基于 API 文档来开展。

而构建 MCP (Model Context Protocol,模型上下文协议) 服务器所需要的全部内容,已经全部包含在 API 文档内了。因此,我们宣布:Apifox 的 API 文档现已全面支持 MCP!

这意味着 AI 助手可以直接访问你发布的 API 在线文档。AI 可以帮助你的团队,甚至访问你的接口文档的任何人,完成编写代码的工作。

Apifox 的 API Hub 内的接口文档,已经全部开启了 MCP 功能,大家可以访问 apifox.com/apihub 直接体验。而对于自己项目的文档,需要手动开启 MCP 功能。

Apifox MCP 能做什么

1. 根据 API 文档,生成数据模型代码

例如:通过 MCP 获取 API 文档,然后生成 Pet 及其相关模型的定义代码

2. 修改 API 文档后,为数据模型代码添加新增的字段

例如:重新读取 API 文档数据,在 Pet DTO 里添加 API 文档新增的几个字段

3. 根据 API 文档,生成接口的 MVC 代码

例如:根据 API 文档,生成接口 /pet 相关的所有 MVC 代码

4. 其他场景

请发挥你和你们团队的想象力...

如何为在线文档开启 MCP 功能

在开始之前,请将 Apifox 更新到最新版 (≥ 2.7.2) ,旧版本没有为在线文档开启 MCP 的入口。

步骤 1:开启 MCP 服务

进入 Apifox 项目,依次点击「分享文档 -> 发布文档站 -> AI 功能」,开启 MCP 服务。

注意:每个在线文档站的 MCP 服务需单独开启。

步骤 2:获取配置文件

开启后,访问在线文档的接口时,页面将显示 「AI 编程(使用 MCP)」按钮。

点击后,将弹出详细的使用说明和 MCP 配置文件,文件内已自动填充当前文档的 site-id。只需复制该配置,便可用于 IDE 中接入 MCP 服务。

值得一提的是,Apifox API Hub 中的所有开放 API 项目已默认支持 MCP,复制即用,无需二次配置!

如何配置 MCP 客户端

无论你使用的是 Cursor 还是 ****VSCode + Cline,只需简单配置,AI 即可直接读取 API 定义,生成规范代码,提升开发体验。

接下来下文就介绍一下怎么在 Cursor 以及 VSCode + Cline 中配置 MCP。

前置条件

  • 已安装 Node.js 环境 (版本 ≥ 18,推荐最新 LTS 版本)
  • 使用支持 MCP 的 IDE (Cursor 或 VSCode + Cline 插件)
  • 已从 Apifox 在线文档复制了 MCP 的 JSON 配置

在 Cursor 中配置 MCP

打开 Cursor 编辑器,点击右上角 「设置」图标,选择左侧「MCP」选项,点击「+ Add new global MCP server」按钮。

在打开的 mcp.json 文件中,添加“在线文档”中的 MCP 配置,例如:

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"  // 替换为你的 Site ID
      ]
    }
  }
}

如果使用 Windows 操作系统,而上文的配置文件无法正常工作,请改用以下配置:

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"  // 替换为你的 Site ID
      ]
    }
  }
}

此外,你还可以为不同项目单独配置 MCP,方法是在项目根目录下创建 .cursor 文件夹,并在其中创建包含上述配置的 mcp.json 文件。

在 VSCode + Cline 中配置 MCP

在 VSCode 中安装 Cline 插件,打开 Cline 面板,点击 「MCP Servers > Configure MCP Servers」。

在打开的.json文件中添加“在线文档”中的 MCP 配置,例如:

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"  // 替换为你的 Site ID
      ]
    }
  }
}

如果使用 Windows 操作系统,而上文的配置文件无法正常工作,请改用以下配置:

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"  // 替换为你的 Site ID
      ]
    }
  }
}

配置完成后,Cline 会自动启用 MCP 服务,也可以手动点击「开关」按钮启用。

验证配置是否成功

在 IDE 中向 AI 提问:

"请通过 MCP 获取 API 文档,并告诉我项目中有几个接口"

如果 AI 能返回你的 API 文档信息,就说明配置已成功 (Cursor 中请设置为 Agent 模式)

常见问题

Q1:API 文档更新后,如何让 AI 读取最新数据?

API 文档数据会缓存在本地,如果接口文档有更新,记得告诉 AI 刷新接口文档数据,以确保代码生成时使用的是最新版本。

例如:

请重新读取 API 文档数据,在 Pet DTO 里添加 API 文档新增的几个字段

Q2:MCP 是否支持管理多个 API 文档?

是的,你可以在 MCP 配置文件中添加多个 API 文档,方便管理不同项目。例如:

{
  "mcpServers": {
    "DeepSeek API - API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=5435161"
      ]
    },
    "宠物商店 - API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=4997831"
      ]
    }
  }
}

Q3:如何优化 AI 生成的代码?

建议在向 AI 提问时,明确 API 名称或接口功能,例如:

❌ “帮我写个请求代码” (描述不明确,AI 可能无法正确理解)

✅ “基于 API 文档的 /orders 接口,生成 TypeScript API 请求封装” (提供 API 具体信息,生成的结果更精准)

这样 AI 就能更准确地理解 API 需求,提高代码质量。

总结

Apifox MCP 可以让你的 API 文档与 AI 编程深度集成,真正实现“文档即代码”的高效开发体验。1 分钟快速配置,让 AI 成为你的智能助手,从此告别重复劳动,专注核心业务。

关于 Apifox MCP Server 的更多内容,可以查看往期文章: 《一文讲透 MCP,开启 Apifox MCP Server 内测之旅》