niuhe 插件官方教程已經上線, 請訪問: http://niuhe.zuxing.net
niuhe 連接 MCP 介紹
API 文檔的未來:MCP
,讓協作像聊天一樣簡單. MCP
是 Model Context Protocol
(模型上下文協議)的縮寫,是 2024 年 11 月 Claude 的公司 Anthropic 推出并開源的一個新標準。簡單來說, 它就是讓 AI 助手能夠連接到各種第三方數據源的橋梁 ,包括你的內容庫、業務工具和開發環境等等。說白了,就是讓 AI 變得更聰明、回答更準確的一種方式!
利用 apifox-mcp-server
將在線文檔、Swagger/OpenAPI
文件提供給 AI 使用, 從而讓 AI 智能體能夠更好地理解和使用你的 API, 從而提高工作效率。
niuhe
插件生成 swagger.json
文檔功能,能夠完美借助 apifox-mcp-server
實現 MCP
功能。這意味著開發者可以輕松讓 AI 智能體更深入、精準地理解和運用 API,大幅提升工作效率,讓 API 開發與協作變得更加順暢高效。
點擊鏈接查看 API MCP 演示視頻
配置 MCP 客戶端
前置條件
- 已安裝
Node.js
環境(版本號 >= 18,推薦最新的 LTS 版本) - 任意一個支持
MCP
的 IDE:Cursor
VSCode + Cline
插件- 其它
基本步驟
-
確保你有
docs/swagger.json
本地路徑或 url 地址 -
在 IDE 中配置
MCP
將下面 JSON 配置添加到 IDE 對應的 macOS/Linux
MCP
配置文件如下:
{"mcpServers": {"API 文檔": {"command": "npx","args": ["-y","apifox-mcp-server@latest","--oas=<oas-url-or-path>"]}}
}
windows MCP 配置文件如下:
{"mcpServers": {"API 文檔": {"command": "cmd","args": ["/c","npx","-y","apifox-mcp-server@latest","--oas=http://{your domain}/api/hello/docs/"]}}
}
其中
<oas-url-or-path>
可以是:
- 遠程 URL,如:
http://{your domain}/api/hello/docs/
- 本地文件路徑,如:
~/Projects/docs/swagger.json
通過上述操作,你就可以在 IDE 中使用 MCP 連接到你的 API 文檔了。如有其他疑問,請查閱下列參考鏈接或加官方支持群 咨詢。
參考鏈接
- Apifox MCP Server
- 通過 MCP 使用 OpenAPI/Swagger 文檔
- 生成 Swagger 文檔
- Model Context Protocol