讓 AI 理解你的 API:Cursor + Apifox MCP Server 實戰指南
更新于:2025-03-26 20:30:09

引言:AI + API 的強大組合

API 已成為系統間通信的標準方式,而 AI 輔助程式設計正在改變我們的開發流程。將 Apifox MCP Server 與 Cursor 結合,可以讓 AI 直接獲取和理解你的 API 檔,從而大幅提升開發效率和準確性。

本文將詳細介紹如何在 Cursor 中配置 Apifox MCP Server,並通過實際場景展示這種結合如何改變你的開發工作流。

什麼是 Apifox MCP Server?

MCP(Model Context Protocol)是一種使 AI 與外部數據源交互的協定。就像是給 AI 應用設定了一個標準介面,讓它們能夠更輕鬆地連接各種數據源和工具。

使用 Apifox MCP Server,可以將 Apifox 專案內的介面文檔作為數據源提供給 Cursor 等支援 AI 程式設計的 IDE 工具,以便讓 AI 能夠直接訪問項目對應的介面文檔數據。

開發者可以通過 AI 助手完成以下工作:根據介面文件生成或修改代碼、搜索介面文檔內容等等,至於通過這個介面文檔數據能讓 AI 幹什麼更多更強大的活,請發揮你和你們團隊的想像力。

在 Cursor 中配置 Apifox MCP Server

1. 前置準備

  • 確保你已安裝 Node.js 環境(版本 ≥ 18,推薦使用最新的 LTS 版本)

  • 安裝最新版本的 Cursor

  • 有可訪問的 Apifox 專案

2. 獲取必要的憑證

  1. 獲取 Apifox Access Token

  • 打開 Apifox 應用

  • 將滑鼠懸停在右上角頭像上,點擊 “賬號設置 → API 訪問令牌”

  • 創建一個新的 API 訪問令牌並保存

  1. 獲取 Apifox 專案 ID

  • 打開需要連接的 Apifox 專案

  • 在左側邊欄點擊 “項目設置”

  • 在 “基本設置” 頁面中複製專案 ID

3. 配置 Cursor 的 MCP 設置

你可以通過兩種方式配置 Cursor 的 MCP:全域配置或專案配置。

方式一:全域配置(推薦)

  1. 打開 Cursor,點擊右上角「設置」圖示,選擇左側「MCP」選項,然後點擊「+ Add new global MCP server」按鈕。

  1. 在打開的 mcp.json 檔中添加以下配置,注意替換 和 為你自己的值:

{ "mcpServers": { "API 文件": { "command": "npx", "args": [ "-y", "apifox-mcp-server@latest", "--project=" ], "env": { "APIFOX_ACCESS_TOKEN": "" } } } }

如果你使用的是 Windows 系統,可能需要使用這個配置:

{ "mcpServers": { "API 文件": { "command": "cmd", "args": [ "/c", "npx", "-y", "apifox-mcp-server@latest", "--project=" ], "env": { "APIFOX_ACCESS_TOKEN": "" } } } }

方式二:專案特定配置

  1. 在你的專案根目錄下創建 .cursor 資料夾(如果不存在)

  2. 在此資料夾中創建 mcp.json 文件

  3. 使用與上面相同的配置

4. 驗證 MCP 連接

配置完成後,你可以通過向 AI 詢問以驗證連接是否正常工作(Agent 模式),例如:

請通過 MCP 獲取 API 文件,並告訴我專案中有幾個介面

如果 AI 能夠返回你 Apifox 專案中的 API 資訊,說明連接成功。

實際應用場景:讓 AI + API 開發更高效

下面我們來看一些將 Apifox MCP Server 與 Cursor 結合使用的實際場景:

場景一:快速生成模型代碼

假設你正在開發一個電商應用,API 文件中已經定義了產品相關的介面和數據結構。

步驟:

  1. 打開 Cursor 並創建一個新專案

  2. 向 AI 發出如下請求:

通過 MCP 獲取 API 文件,然後為產品相關 API 生成完整的 TypeScript 介面定義和服務類

AI 將:

  1. 通過 MCP 讀取你的 API 文件

  2. 分析產品相關的介面和數據結構

  3. 生成符合你 API 規範的 TypeScript 介面和服務類代碼

示例輸出可能是這樣的:

場景二:介面文件與代碼同步更新

當 API 文件有更新時,需要同步更新代碼。

步驟:

  1. 在 Apifox 中更新產品 API,添加新欄位 discountPrice

  2. 向 AI 請求更新代碼:

API 文件已更新,請刷新 MCP 緩存,並更新 Product 介面,添加 API 文件中新增的欄位

AI 將:

  1. 刷新 MCP 緩存以獲取最新的 API 文件

  2. 識別出新增的 discountPrice 欄位

  3. 更新你的 Product 介面代碼

示例:

export interface Product { id: string; name: string; description: string; price: number; discountPrice?: number; // 新增欄位 category: string; imageUrls: string[]; inStock: boolean; createdAt: string; updatedAt: string; }

場景三:根據 API 生成完整的 CRUD 操作

對於後端開發者,可以根據 API 文檔自動生成完整的 Controller、Service 和 Repository 代碼。

步驟:

要求 AI 生成代碼:

根據 API 文件,為使用者管理模組生成完整的 Spring Boot MVC 代碼,包括 Controller、Service 和 Repository

AI 將生成符合你 API 規範的完整 Spring Boot 代碼結構。

場景四:API 文件搜索與問答

你可以使用 AI 來搜索和理解複雜的 API 文件。

示例查詢:

在 API 文件中,查找與支付相關的所有介面,並解釋它們的關係和使用流程

AI 會:

  1. 通過 MCP 搜索 API 文件中與支付相關的介面

  2. 分析這些介面之間的關係

  3. 以易於理解的方式解釋支付流程

場景五:根據 API 自動生成測試用例

步驟:

請求 AI 生成測試代碼:

根據 MCP 中的 API 文件,為產品創建介面生成完整的單元測試和集成測試代碼,使用 Jest 框架

AI 將生成符合你 API 規範的測試代碼,包括正常情況和各種邊界條件的測試。

高級技巧與最佳實踐

1. 管理多個 API 專案

如果你需要在同一個開發環境中使用多個 Apifox 專案的 API 文件,可以在 MCP 配置中添加多個服務:

{ "mcpServers": { "商城 API 文件": { "command": "npx", "args": [ "-y", "apifox-mcp-server@latest", "--project=123456" ], "env": { "APIFOX_ACCESS_TOKEN": "" } }, "CRM API 文件": { "command": "npx", "args": [ "-y", "apifox-mcp-server@latest", "--project=654321" ], "env": { "APIFOX_ACCESS_TOKEN": "" } } } }

在向 AI 提問時,明確指定你想使用哪個 API 文件:

請使用商城 API 文件,為訂單管理模組生成代碼

2. 安全性最佳實踐

為避免在團隊協作時共用 Access Token,可以:

  1. 從配置檔中移除 "APIFOX_ACCESS_TOKEN": "" 部分

  2. 在每個開發者的系統中設置環境變數 APIFOX_ACCESS_TOKEN

3. 提高 AI 回應品質的提示技巧

  • 明確指定需要的文件部分:例如,"請查看使用者模組的 API 文件"

  • 指定代碼風格和約定:例如,"按照我們團隊的 TypeScript 命名規範生成代碼"

  • 要求添加註釋:例如,"生成代碼時,為每個方法添加詳細的 JSDoc 註釋"

  • 分步請求:對於複雜任務,先請求 AI 列出計劃,然後一步步執行

結語

將 Apifox MCP Server 與 Cursor 結合使用,為開發者提供了前所未有的 API 開發體驗。通過讓 AI 直接訪問 API 文件,你可以:

  1. 大幅減少從 API 規範到代碼實現的轉換時間

  2. 降低人工錯誤的可能性

  3. 加速反覆運算和更新過程

  4. 提高代碼品質和一致性

隨著 Apifox MCP Server 的不斷完善,我們可以期待更多強大的功能來優化 API 開發流程。無論是前端還是後端開發者,這種 AI 與 API 文檔的結合都將帶來顯著的生產力提升。