后端文档常常是swagger文档,后端自测接口并不方便,前端联调查找接口也很费劲
本文实现:
- 一键将swagger文档导入到 apifox,便于后端同学自测接口
- 借助 apifox MCP 能力,前端同学通过提示词一键生成接口代码
1.swagger文档导入apifox
1. 从apifox官网下载并安装客户端
- 安装下载后,注册一个账号
- 打开 API访问令牌 获取到这个Key
2. 在 Idea 中安装 Apifox Helper 插件
3. swagger文档导入apifox
- Idea打开项目,然后设置 key 和 项目ID
- 设置完成后,将api全部导入到apifox
导入成功后,在客户端中的目录中就可以看到所有接口
2. apifox 开启MCP
在开始之前,请将 Apifox 更新到最新版 (≥ 2.7.2) ,旧版本没有为在线文档开启 MCP 的入口。
2.1:开启 MCP 服务
进入 Apifox 项目,依次点击「分享文档 -> 发布文档站 -> AI 功能」,开启 MCP 服务。
注意:每个在线文档站的 MCP 服务需单独开启。
2.2:获取配置文件
开启后,访问在线文档的接口时,页面将显示 「AI 编程(使用 MCP)」按钮。
点击后,将弹出详细的使用说明和 MCP 配置文件,文件内已自动填充当前文档的 site-id。只需复制该配置,便可用于 IDE 中接入 MCP 服务。
3.在 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 文件。
4. 在 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
]
}
}
}
验证配置是否成功
在 IDE 中向 AI 提问:“请通过 MCP 获取 API 文档,并告诉我项目中有几个接口”
如果 AI 能返回你的 API 文档信息,就说明配置已成功 (Cursor 中请设置为 Agent 模式) 。
常见问题
Q1:API 文档更新后,如何让 AI 读取最新数据?
API 文档数据会缓存在本地,如果接口文档有更新,记得告诉 AI 刷新接口文档数据,以确保代码生成时使用的是最新版本。
例如: JSON 代码解读复制代码请重新读取 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 需求,提高代码质量。