Apifox MCP服务端

你是否曾经希望AI能够直接读取你的API文档，根据接口定义自动生成代码、添加字段注释、创建MVC结构？今天要介绍的开源项目Apifox MCP服务端，正是为了实现这个目标而设计的。它将AI代码助手连接到Apifox API定义，让开发者能够通过自然语言命令实现API开发。

项目基本信息

一、项目介绍

Apifox MCP服务端是一个让AI能够访问Apifox项目中API文档的MCP服务器。它自动读取整个项目里的所有接口文档数据并缓存在本地，让AI可以通过MCP读取所有接口的文档数据。

使用这个工具，开发者可以通过自然语言命令让AI完成：

• 根据接口文档生成或修改代码
• 搜索接口文档内容
• 生成DTO模型定义代码
• 添加字段注释
• 生成MVC代码

二、核心优势

API文档驱动开发

让AI直接基于API文档生成代码，确保代码与文档同步。

自然语言交互

通过自然语言命令操作，无需手动查阅文档。

多项目支持

支持配置多个项目，每个项目对应不同的API文档。

缓存机制

接口文档数据缓存在本地，提高访问速度。

支持多种数据源

支持Apifox项目和Swagger/OAS文件。

三、适用场景

API代码生成

根据API文档自动生成Model、Controller、Service代码。

文档同步开发

确保代码实现与API文档保持一致。

快速原型开发

根据API定义快速搭建项目骨架。

接口搜索

通过AI快速搜索和查找接口文档内容。

四、安装教程

系统要求

安装步骤

第一步：获取Apifox Access Token

1. 打开Apifox，点击右上角头像
2. 选择“账号设置” -> “API访问令牌”
3. 创建新的API访问令牌
4. 复制保存生成的令牌

第二步：获取Apifox项目ID

1. 打开Apifox中对应的项目
2. 点击左侧边栏“项目设置”
3. 在“基本设置”页面复制项目ID

第三步：配置IDE

对于Cursor：

编辑~/.cursor/mcp.json或项目内的.cursor/mcp.json：

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=你的项目ID"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "你的Access Token"
      }
    }
  }
}

对于Windows系统：

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=你的项目ID"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "你的Access Token"
      }
    }
  }
}

对于Cline：

打开Cline面板 -> MCP Server -> Configure MCP Server，添加相同配置。

五、使用示例

配置完成后，你就可以在MCP客户端中使用自然语言来操作了。

示例1：生成模型代码

用户指令：“通过MCP获取API文档，然后生成Product及其相关模型的定义代码”

AI会读取API文档，生成对应的DTO模型代码。

示例2：添加字段

用户指令：“根据API文档，在Product DTO里添加API文档新增的几个字段”

AI会对比文档，自动添加缺失的字段。

示例3：添加注释

用户指令：“根据API文档给Product类的每个字段都加上注释”

AI会根据文档中的字段描述，为每个属性添加注释。

示例4：生成MVC代码

用户指令：“根据API文档，生成接口/users相关的所有MVC代码”

AI会生成Controller、Service、Repository等完整代码。

示例5：刷新缓存

用户指令：“刷新接口文档数据”

当Apifox数据更新后，告诉AI刷新缓存以获取最新数据。

示例6：使用Swagger/OAS文件

不指定project-id，使用--oas参数：

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "你的Access Token"
      }
    }
  }
}

示例7：私有化部署

添加--apifox-api-base-url参数：

{
  "args": [
    "-y",
    "apifox-mcp-server@latest",
    "--project-id=项目ID",
    "--apifox-api-base-url=https://your-apifox-server.com"
  ]
}

六、常见问题

问题1：配置文件无法正常工作（Windows）

解决方案：使用Windows特定的配置，使用cmd作为command。

问题2：Access Token无效

解决方案：重新生成Access Token，确保权限正确。

问题3：项目ID错误

解决方案：确认项目ID正确，从项目设置中复制。

问题4：数据不是最新的

解决方案：告诉AI“刷新接口文档数据”，AI会重新拉取。

问题5：多个项目如何配置

解决方案：配置多个MCP Server，每个使用不同的project-id和名称。

七、总结

Apifox MCP服务端是一个让AI能够直接访问API文档的MCP服务器，通过自然语言命令实现API代码生成。

这个项目的最大价值在于：

1. API文档驱动：让AI基于文档生成代码
2. 自然语言交互：无需手动查阅文档
3. 多项目支持：可配置多个API项目
4. 本地缓存：提高访问速度
5. MIT许可证：可自由使用和修改

如果你是API开发者，并且希望用AI来自动化代码生成，Apifox MCP服务端是一个非常实用的工具。