日常開發過程中,尤其是針對長期維護的老舊項目,許多開發者都會遇到一系列相同的困擾:由于項目早期缺乏嚴格的開發規范和接口管理策略,導致接口文檔缺失,甚至連基本的接口說明都難以找到。此外,由于缺乏規范化的接口測試,項目維護人員不得不耗費大量時間理解代碼邏輯,進而手動驗證接口功能。這種狀態不僅降低了開發效率,還嚴重影響了項目交接的順利進行。
今天在cursor中通過ApiFox MCP工具,一鍵獲取接口信息,一鍵實現接口測試,從而大幅提高接口管理效率。
一、老舊接口面臨的典型問題
老舊接口在開發和維護中面臨以下突出問題:
-
文檔缺失或不全: 在項目早期,由于開發節奏快,缺乏嚴格的接口文檔規范,導致后期維護人員難以快速掌握接口功能與調用方式。
-
接口測試缺失: 老舊項目的接口通常沒有對應的自動化測試腳本,測試往往依靠手工操作,不僅效率低下,也容易遺漏細節問題。
-
維護難度高: 缺乏清晰的接口文檔和有效的測試手段,使得后續維護人員需要花費大量時間閱讀代碼和調試接口。
這些問題在長期維護項目中尤為明顯,使得開發維護成本持續攀升。
二、ApiFox MCP的核心能力
1. 讀取個人項目的OpenApi Spec文件內容
2.?讀取個人項目"的OpenAPISpec文件內$ref的文件內容,可以同時獲取多個文件內容
Parameters:
path:OpenAPISpec文件內$ref的值,可以同時獲取多個文件內容,如:["/paths/_get_pet.json"
"/paths/_get_order.json"]
3.?從服務器重新下載最新的"個人項目"的OpenAPISpec文件內容
有了上面的幾個核心能力,我們就可以:根據接口文檔生成或修改代碼、搜索接口文檔內容等等,至于通過這個接口文檔數據能讓 AI 干什么更多更強大的活,請發揮你和你的想象力。
三、ApiFox MCP詳細操作指南
這里我用到了一個idea集成的工具 叫 Cool Request, 為什么不用ApiFox自帶的ApiFox 插件,是因為Cool Request太好用了,雖然同樣擁有定位接口,直接加載項目中接口的能力,但是CoolRequest可以直接調正在運行中的spring中的方法,也就是說,任何的方法,只要你想調,隨時都能通過CoolRequest去調用,這個絕對是開發過程中調試bug的神器。
好了,不說太多了,有點兒跑題了,可能有人會有疑問,說ApiFox MCP怎么就扯到了Cool Request上了,那么這兩個有什么關系呢?
我通過Cool Request可以一鍵將Api接口導入到ApiFox中,具體操作如下:
如果第一次操作,會彈出需要配置ApiFox
可以參考官網
1. HTTP Authorization
用于獲取、添加用戶自定義目錄
該Token請在Web端登錄后,按下F12進入開發者模式,任意選擇一個請求,點擊詳情,在請求頭中復制Authorization值。
2. openapi token
下載一個官方客戶端,或在官方登錄后,在賬號設置中,可以新建一個訪問令牌
設置好這兩項之后,就可以一鍵導入Cool Request的api接口到ApiFox中了。
接下來需要配置ApiFox MCP server。在Cursor中, 添加配置
"API 文檔": {"command": "cmd","args": ["/c","npx","-y","apifox-mcp-server@latest","--project=XXXXXX"],"env": {"APIFOX_ACCESS_TOKEN": "XXXXXX"}
}
替換project和APIFOX_ACCESS_TOKEN
project如下圖在項目設置中找到基本設置,項目id。token與上文中的token為同一令牌。
設置好之后,就可以問cursor了
我發現,我問的時候,調用MCP工具查到了好多個跟 “航線” 相關的接口,即使我把名稱原封不動的復制進來也是存在這樣的問題。如果碰到這種問題怎么解決呢?
直接復制ApiFox的接口id來讓MCP精確執行
我們可以看到他會先刷新接口信息,根據最新的接口獲取詳情,然后再去生成對應的接口文檔。
接下來,我讓他幫我生成接口自動化測試,他也能很好的寫出來。
四、ApiFox MCP實戰效果
通過ApiFox MCP工具,我們能夠:
-
效率顯著提高: 接口文檔和測試腳本自動生成,省去了大量手動撰寫文檔和人工測試的時間。
-
接口質量穩步提升: 自動化測試腳本有效減少了人工測試的遺漏,接口質量得到保障。
-
維護成本降低: 清晰易讀的自動生成文檔使得新成員快速上手,大幅降低了知識傳遞成本。
五、ApiFox MCP應用場景
ApiFox MCP尤其適用于以下場景:
-
老舊項目的維護與升級。
-
團隊人員頻繁更替,需要快速交接項目。
-
快速迭代的敏捷項目,需迅速生成和驗證接口。