這種方式不僅容易導(dǎo)致數(shù)據(jù)同步不一致,還阻礙了團(tuán)隊(duì)成員之間的協(xié)作,最終影響開(kāi)發(fā)效率。面對(duì)這些問(wèn)題,如果有一個(gè)一體化的平臺(tái),能將 API 的設(shè)計(jì)、開(kāi)發(fā)、測(cè)試等所有環(huán)節(jié)整合在一起,會(huì)是多么方便!在這樣的平臺(tái)上,團(tuán)隊(duì)成員可以共享一份清晰的 API 文檔,后端開(kāi)發(fā)可以根據(jù)接口文檔快速開(kāi)發(fā)并調(diào)試 API。前端開(kāi)發(fā)可以輕松調(diào)用 API 并獲取 Mock 數(shù)據(jù),測(cè)試工程師也能高效地進(jìn)行 API 測(cè)試工作。這樣一來(lái),整個(gè)團(tuán)隊(duì)的協(xié)作將會(huì)更加順暢,開(kāi)發(fā)效率也會(huì)顯著提高。今天我們介紹的這款A(yù)PI管理神器– Apifox ,正是這樣一個(gè)一站式 API 開(kāi)發(fā)協(xié)作平臺(tái)!它集 API 設(shè)計(jì)、API 開(kāi)發(fā)、API 調(diào)試、API 管理、 API 文檔、API Mock 和自動(dòng)化測(cè)試等功能于一體,為我們的 API 項(xiàng)目提供一站式的解決方案。

image

Apifox 如何整合你的工作流?

在?Apifox?中,所有操作都圍繞 API 定義?(API specification)?展開(kāi),每個(gè)角色都可以直接利用設(shè)計(jì)好的 API 來(lái)發(fā)送請(qǐng)求、創(chuàng)建接口用例、生成 Mock 數(shù)據(jù)和發(fā)布文檔。

image

角色說(shuō)明

.yaml

.json

文件),并支持使用迭代分支來(lái)設(shè)計(jì) API。

image

工作流程優(yōu)勢(shì)

  1. 緊密協(xié)作:促進(jìn)團(tuán)隊(duì)各角色間的高效合作,實(shí)現(xiàn) API 的持續(xù)迭代。
  2. 有組織的 API 管理:統(tǒng)一管理 API,避免在多個(gè)工具之間頻繁切換,提高工作效率。
  3. 良好的開(kāi)發(fā)體驗(yàn):提供設(shè)計(jì)優(yōu)良且文檔完善的 API,提升開(kāi)發(fā)者體驗(yàn),縮短學(xué)習(xí)曲線。

Apifox 是專(zhuān)門(mén)為 API 設(shè)計(jì)和開(kāi)發(fā)團(tuán)隊(duì)量身定制的協(xié)作平臺(tái)。

Apifox 豐富且強(qiáng)大的功能

Apifox 提供了一系列豐富且強(qiáng)大的功能,幫助你在開(kāi)發(fā)和管理 API 時(shí)更加高效:

  1. 自動(dòng)生成請(qǐng)求參數(shù)與請(qǐng)求體:根據(jù)你定義的接口自動(dòng)生成對(duì)應(yīng)的請(qǐng)求參數(shù)和請(qǐng)求體,不需要手動(dòng)輸入,減少人為錯(cuò)誤,確保發(fā)送的請(qǐng)求與接口定義完全一致。
  2. 自動(dòng)校驗(yàn)響應(yīng):自動(dòng)檢查接口返回的響應(yīng),校驗(yàn)響應(yīng)是否符合預(yù)先定義的數(shù)據(jù)結(jié)構(gòu),快速發(fā)現(xiàn)接口返回與預(yù)期不符的情況。
  3. 可視化斷言和變量提取:通過(guò)圖形界面創(chuàng)建斷言測(cè)試,可視化地從接口響應(yīng)中提取需要的變量。
  4. 兼容 Postman 腳本:完全支持并兼容 Postman 格式的腳本,可以直接導(dǎo)入現(xiàn)有的 Postman 腳本,讓熟悉 Postman 的團(tuán)隊(duì)無(wú)縫切換。
  5. 執(zhí)行數(shù)據(jù)庫(kù)操作:可以直接連接數(shù)據(jù)庫(kù),并在測(cè)試接口時(shí)執(zhí)行數(shù)據(jù)庫(kù)操作,支持?jǐn)?shù)據(jù)庫(kù)的增刪改查功能。
  6. 將請(qǐng)求保存為接口用例:把已調(diào)試好的接口請(qǐng)求直接保存,轉(zhuǎn)換為可重復(fù)使用的接口用例,方便構(gòu)建測(cè)試集合,編排測(cè)試場(chǎng)景。
  7. 調(diào)用外部程序:支持與多種編程語(yǔ)言集成,幫助團(tuán)隊(duì)根據(jù)需求擴(kuò)展功能,自定義工作流程。
  8. 兼容微服務(wù)場(chǎng)景:適配微服務(wù)系統(tǒng),幫助管理復(fù)雜的分布式 API,支持微服務(wù)間的切換測(cè)試。
  9. 自動(dòng)生成 Mock 數(shù)據(jù):根據(jù)你定義的接口自動(dòng)生成 Mock 數(shù)據(jù),幫助前端團(tuán)隊(duì)獨(dú)立開(kāi)發(fā),加速進(jìn)度。
  10. 將快捷請(qǐng)求保存為接口:自動(dòng)分析已發(fā)送的快捷請(qǐng)求,可保存標(biāo)準(zhǔn)的接口文檔,簡(jiǎn)化接口文檔維護(hù)工作。
  11. 可視化編排測(cè)試場(chǎng)景:圖形化界面編排測(cè)試場(chǎng)景,可視化管理測(cè)試步驟,支持創(chuàng)建復(fù)雜的測(cè)試場(chǎng)景。
  12. 自托管 Runner Mock:支持在自有服務(wù)器部署 Apifox 的 Runner,提供獨(dú)立的 Mock 服務(wù),滿(mǎn)足安全性和性能要求。

Apifox MCP Server介紹

Apifox MCP Server,可以將 Apifox 的接口文檔提供給 Cursor 等支持 AI 編程的 IDE,或其他支持 MCP 的 AI 工具。

image

有了 Apifox MCP Server,我們開(kāi)發(fā)者就可以通過(guò) AI 助手完成以下工作:根據(jù)接口文檔生成或修改代碼、搜索接口文檔內(nèi)容等等,至于通過(guò)這個(gè)接口文檔數(shù)據(jù)還能讓AI幫我們完成哪些更多更強(qiáng)大的任務(wù),這個(gè)就需要我們自己盡情的發(fā)揮想象力,哈哈。

如何讓 API 文檔開(kāi)啟 MCP 功能

通過(guò) MCP 使用 Apifox 項(xiàng)目?jī)?nèi)的 API 文檔

Apifox MCP Server 可以將項(xiàng)目?jī)?nèi)的 API 文檔提供給 AI 使用。

配置 MCP 客戶(hù)端前置條件

在 Apifox 生成 API 個(gè)人訪問(wèn)令牌:打開(kāi) Apifox,將鼠標(biāo)懸停在頁(yè)面右上角的頭像上,點(diǎn)擊 “賬號(hào)設(shè)置 -> API 訪問(wèn)令牌”,創(chuàng)建新的 API 訪問(wèn)令牌,替換下面配置文件中的

image

獲取 Apifox 項(xiàng)目 ID:打開(kāi) Apifox 里對(duì)應(yīng)的項(xiàng)目,在左側(cè)邊欄點(diǎn)擊 “項(xiàng)目設(shè)置”,在 “基本設(shè)置” 頁(yè)面即可復(fù)制項(xiàng)目ID,拿到項(xiàng)目ID,替換下面配置文件中的

image

在 Cursor 中配置 MCP:編輯 MCP 配置文件:打開(kāi)Cursor編輯器,點(diǎn)擊右上角“設(shè)置”圖標(biāo),選擇左側(cè)“MCP”選項(xiàng),點(diǎn)擊“+ Add new global MCP server“按鈕。

image

添加配置內(nèi)容:在打開(kāi)的

mcp.json

文件中添加以下配置,注意替換

為你自己的值:

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

驗(yàn)證配置:配置完成后,你可以通過(guò)向 AI 詢(xún)問(wèn)以驗(yàn)證連接是否正常工作(Agent 模式)。例如:請(qǐng)通過(guò) MCP 獲取 API 文檔,并告訴我項(xiàng)目中有幾個(gè)接口,如果 AI 能夠返回你 Apifox 項(xiàng)目中的 API 信息,說(shuō)明連接成功。

image

在 Cline 中配置 MCP

安裝 Cline 插件:在 VSCode 擴(kuò)展市場(chǎng)搜索并安裝 “Cline” 插件;配置 MCP 服務(wù)器:打開(kāi) Cline 面板,點(diǎn)擊 「MCP Servers > Configure MCP Servers」。

image

在打開(kāi)的

.json

文件中添加以下配置,注意替換

為你自己的值:

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

驗(yàn)證配置:配置完成后,你可以通過(guò)向 AI 詢(xún)問(wèn)以驗(yàn)證連接是否正常工作。例如:請(qǐng)通過(guò) MCP 獲取 API 文檔,并告訴我項(xiàng)目中有幾個(gè)接口。如果 AI 能夠返回你 Apifox 項(xiàng)目中的 API 信息,說(shuō)明連接成功。

image

通過(guò) MCP 使用公開(kāi)發(fā)布的 API 文檔

Apifox MCP Server 可以將公開(kāi)發(fā)布的在線文檔提供給 AI 使用,僅支持公開(kāi)發(fā)布、任何人都可以直接訪問(wèn)的在線文檔。不支持設(shè)置了密碼、郵箱白名單、IP 白名單的在線文檔。如果不希望公開(kāi)接口文檔,僅僅是內(nèi)部人員可以訪問(wèn)。

image

為在線文檔開(kāi)啟 MCP 功能前置條件

≥ 2.7.2

開(kāi)啟 MCP 服務(wù):進(jìn)入Apifox項(xiàng)目,依次點(diǎn)擊“分享文檔 -> 發(fā)布文檔站 -> AI 功能”,開(kāi)啟 MCP 服務(wù)。

image

獲取配置文件:開(kāi)啟后,訪問(wèn)在線文檔的接口時(shí),頁(yè)面將顯示“AI 編程(使用 MCP)”按鈕。

image

點(diǎn)擊后,將彈出詳細(xì)的使用說(shuō)明和 MCP 配置文件,文件內(nèi)已自動(dòng)填充當(dāng)前文檔的

site-id

。只需復(fù)制該配置,便可用于 IDE 中接入 MCP 服務(wù)。

image

配置 MCP 客戶(hù)端前置條件

在 Cursor 中配置 MCP

編輯MCP配置文件:打開(kāi)Cursor編輯器,點(diǎn)擊右上角 “設(shè)置”圖標(biāo),選擇左側(cè)“MCP”選項(xiàng),點(diǎn)擊“+ Add new global MCP server”按鈕。

image

添加配置內(nèi)容:在打開(kāi)的

mcp.json

文件中,添加從 “在線文檔” 中復(fù)制的的 MCP 配置,例如:

{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--site-id=123456"
]
}
}
}

驗(yàn)證配置:配置完成后,你可以通過(guò)向 AI 詢(xún)問(wèn)以驗(yàn)證連接是否正常工作(Agent 模式)。例如:請(qǐng)通過(guò) MCP 獲取 API 文檔,并告訴我項(xiàng)目中有幾個(gè)接口,如果 AI 能夠返回你 Apifox 項(xiàng)目中的 API 信息,說(shuō)明連接成功。

image

在 Cline 中配置 MCP

安裝 Cline 插件:在 VSCode 擴(kuò)展市場(chǎng)搜索并安裝 “Cline” 插件配置 MCP 服務(wù)器:打開(kāi) Cline 面板,點(diǎn)擊“MCP Servers>Configure MCP Servers”。

image

在打開(kāi)的

.json

文件中添加 “在線文檔” 中的 MCP 配置,例如:

{
"mcpServers": {
"API 文檔": {
"command":?"npx",
"args": [
"-y",
"apifox-mcp-server@latest",
"--site-id=123456"
]
}
}
}

驗(yàn)證配置:配置完成后,你可以通過(guò)向 AI 詢(xún)問(wèn)以驗(yàn)證連接是否正常工作。例如:請(qǐng)通過(guò) MCP 獲取 API 文檔,并告訴我項(xiàng)目中有幾個(gè)接口,如果 AI 能夠返回你 Apifox 項(xiàng)目中的 API 信息,說(shuō)明連接成功。

image

注意事項(xiàng)

如果需要使用到多個(gè) API 文檔,在配置文件里添加配置多個(gè) MCP Server 即可(不同文檔有不同的

)。

至此,我們已經(jīng)完成了Apifox MCP 使用流程講解,大家有問(wèn)題可以評(píng)論區(qū)留言討論。

寫(xiě)在最后

Apifox MCP 可以讓你的API 文檔與AI編程深度集成,真正實(shí)現(xiàn)“文檔即代碼”的高效開(kāi)發(fā)體驗(yàn)。想體驗(yàn)的小伙伴抓緊動(dòng)手實(shí)操起來(lái)吧。

原文轉(zhuǎn)載自:https://mp.weixin.qq.com/s/fZ-MUfNxO1OvsLKvJsY9HQ

上一篇:

70k star,取代Postman!這款輕量級(jí)API工具,太香了!

下一篇:

FastOpenAPI:Python框架API文檔自動(dòng)化生成工具,解放你的雙手!
#你可能也喜歡這些API文章!

我們有何不同?

API服務(wù)商零注冊(cè)

多API并行試用

數(shù)據(jù)驅(qū)動(dòng)選型,提升決策效率

查看全部API→
??

熱門(mén)場(chǎng)景實(shí)測(cè),選對(duì)API

#AI文本生成大模型API

對(duì)比大模型API的內(nèi)容創(chuàng)意新穎性、情感共鳴力、商業(yè)轉(zhuǎn)化潛力

25個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)

#AI深度推理大模型API

對(duì)比大模型API的邏輯推理準(zhǔn)確性、分析深度、可視化建議合理性

10個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)