
APISIX-MCP:利用 AI + MCP 擁抱 API 智能化管理
這種方式不僅容易導致數據同步不一致,還阻礙了團隊成員之間的協作,最終影響開發效率。面對這些問題,如果有一個一體化的平臺,能將 API 的設計、開發、測試等所有環節整合在一起,會是多么方便!在這樣的平臺上,團隊成員可以共享一份清晰的 API 文檔,后端開發可以根據接口文檔快速開發并調試 API。前端開發可以輕松調用 API 并獲取 Mock 數據,測試工程師也能高效地進行 API 測試工作。這樣一來,整個團隊的協作將會更加順暢,開發效率也會顯著提高。今天我們介紹的這款API管理神器– Apifox ,正是這樣一個一站式 API 開發協作平臺!它集 API 設計、API 開發、API 調試、API 管理、 API 文檔、API Mock 和自動化測試等功能于一體,為我們的 API 項目提供一站式的解決方案。
在?Apifox?中,所有操作都圍繞 API 定義?(API specification)?展開,每個角色都可以直接利用設計好的 API 來發送請求、創建接口用例、生成 Mock 數據和發布文檔。
.yaml
或
.json
文件),并支持使用迭代分支來設計 API。
后端開發:可以直接根據定義好的 API 來發送請求,或生成后端業務代碼。
前端開發:不用等后端完成,可以直接基于 API 定義生成 Mock 數據。
測試工程師:可以基于 API 定義自動生成接口用例,提供可視化界面來編排測試場景,并集成 CI/CD 流水線。
API 文檔維護者:可以一鍵生成規范的 API 文檔,文檔會隨 API 定義的更新自動保持同步。
性能測試人員:提供專門的性能測試功能。
Apifox 是專門為 API 設計和開發團隊量身定制的協作平臺。
Apifox 提供了一系列豐富且強大的功能,幫助你在開發和管理 API 時更加高效:
Apifox MCP Server,可以將 Apifox 的接口文檔提供給 Cursor 等支持 AI 編程的 IDE,或其他支持 MCP 的 AI 工具。
有了 Apifox MCP Server,我們開發者就可以通過 AI 助手完成以下工作:根據接口文檔生成或修改代碼、搜索接口文檔內容等等,至于通過這個接口文檔數據還能讓AI幫我們完成哪些更多更強大的任務,這個就需要我們自己盡情的發揮想象力,哈哈。
Apifox MCP Server 可以將項目內的 API 文檔提供給 AI 使用。
在 Apifox 生成 API 個人訪問令牌:打開 Apifox,將鼠標懸停在頁面右上角的頭像上,點擊 “賬號設置 -> API 訪問令牌”,創建新的 API 訪問令牌,替換下面配置文件中的
獲取 Apifox 項目 ID:打開 Apifox 里對應的項目,在左側邊欄點擊 “項目設置”,在 “基本設置” 頁面即可復制項目ID,拿到項目ID,替換下面配置文件中的
;
在 Cursor 中配置 MCP:編輯 MCP 配置文件:打開Cursor編輯器,點擊右上角“設置”圖標,選擇左側“MCP”選項,點擊“+ Add new global MCP server“按鈕。
添加配置內容:在打開的
mcp.json
文件中添加以下配置,注意替換
和
為你自己的值:
{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--project="
],
"env": {
"APIFOX_ACCESS_TOKEN":?""
}
}
}
}
驗證配置:配置完成后,你可以通過向 AI 詢問以驗證連接是否正常工作(Agent 模式)。例如:請通過 MCP 獲取 API 文檔,并告訴我項目中有幾個接口,如果 AI 能夠返回你 Apifox 項目中的 API 信息,說明連接成功。
安裝 Cline 插件:在 VSCode 擴展市場搜索并安裝 “Cline” 插件;配置 MCP 服務器:打開 Cline 面板,點擊 「MCP Servers > Configure MCP Servers」。
在打開的
.json
文件中添加以下配置,注意替換
和
為你自己的值:
{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--project="
],
"env": {
"APIFOX_ACCESS_TOKEN":?""
}
}
}
}
驗證配置:配置完成后,你可以通過向 AI 詢問以驗證連接是否正常工作。例如:請通過 MCP 獲取 API 文檔,并告訴我項目中有幾個接口。如果 AI 能夠返回你 Apifox 項目中的 API 信息,說明連接成功。
Apifox MCP Server 可以將公開發布的在線文檔提供給 AI 使用,僅支持公開發布、任何人都可以直接訪問的在線文檔。不支持設置了密碼、郵箱白名單、IP 白名單的在線文檔。如果不希望公開接口文檔,僅僅是內部人員可以訪問。
≥ 2.7.2
開啟 MCP 服務:進入Apifox項目,依次點擊“分享文檔 -> 發布文檔站 -> AI 功能”,開啟 MCP 服務。
獲取配置文件:開啟后,訪問在線文檔的接口時,頁面將顯示“AI 編程(使用 MCP)”按鈕。
點擊后,將彈出詳細的使用說明和 MCP 配置文件,文件內已自動填充當前文檔的
site-id
。只需復制該配置,便可用于 IDE 中接入 MCP 服務。
編輯MCP配置文件:打開Cursor編輯器,點擊右上角 “設置”圖標,選擇左側“MCP”選項,點擊“+ Add new global MCP server”按鈕。
添加配置內容:在打開的
mcp.json
文件中,添加從 “在線文檔” 中復制的的 MCP 配置,例如:
{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--site-id=123456"
]
}
}
}
驗證配置:配置完成后,你可以通過向 AI 詢問以驗證連接是否正常工作(Agent 模式)。例如:請通過 MCP 獲取 API 文檔,并告訴我項目中有幾個接口,如果 AI 能夠返回你 Apifox 項目中的 API 信息,說明連接成功。
安裝 Cline 插件:在 VSCode 擴展市場搜索并安裝 “Cline” 插件配置 MCP 服務器:打開 Cline 面板,點擊“MCP Servers>Configure MCP Servers”。
在打開的
.json
文件中添加 “在線文檔” 中的 MCP 配置,例如:
{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--site-id=123456"
]
}
}
}
驗證配置:配置完成后,你可以通過向 AI 詢問以驗證連接是否正常工作。例如:請通過 MCP 獲取 API 文檔,并告訴我項目中有幾個接口,如果 AI 能夠返回你 Apifox 項目中的 API 信息,說明連接成功。
如果需要使用到多個 API 文檔,在配置文件里添加配置多個 MCP Server 即可(不同文檔有不同的
)。
至此,我們已經完成了Apifox MCP 使用流程講解,大家有問題可以評論區留言討論。
Apifox MCP 可以讓你的API 文檔與AI編程深度集成,真正實現“文檔即代碼”的高效開發體驗。想體驗的小伙伴抓緊動手實操起來吧。
原文轉載自:https://mp.weixin.qq.com/s/fZ-MUfNxO1OvsLKvJsY9HQ