AI Features

透過 AI 功能讓你的 API 文件為 AI 做好準備，實現與 AI 助理和開發工具的無縫整合。這些功能可協助開發者運用 Cursor、Cline 及其他 AI 驅動的 IDE 等 AI 工具，加速 API 整合與程式碼產生。

版本需求

Apidog 版本必須 ≥ 2.7.2 才能使用這些功能。

若要啟用這些功能： 前往 Publish Docs → Publish Docs Sites → AI Features。

Ask AI

此功能會在你的文件頁面上啟用對話式搜尋功能。你可以連接來自 Algolia 的 AI Assistant 來使用此功能。你可以在 Documentation Search 頁面的 Ask AI 區段了解更多此功能。

Enable MCP (Model Context Protocol)

啟用後，你的文件中會出現一個「MCP」按鈕，引導使用者了解如何將你的 API 文件連接到支援 MCP 的 IDE，例如 Cursor 和 Cline。這可讓 Agentic AI 直接根據你的 API 文件協助產生程式碼。

了解更多

如需詳細設定說明，請閱讀：Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server。

Enable Copy Page

啟用後，你的文件中會出現「Copy page」按鈕，允許使用者將目前頁面以 Markdown 格式複製，非常適合貼到 AI 對話中。

Enable llms.txt

啟用後，系統會在你的文件網站根目錄中自動產生一個 llms.txt Markdown 檔案。此檔案包含每個 Markdown 頁面的連結與簡潔描述，讓 AI 助理能輕鬆探索並瀏覽你的文件。

範例：

AI 助理如何使用 llms.txt

使用 llms.txt 及相關 Markdown 檔案通常有兩種方法：

1. 與可存取 URL 的 AI 助理分享 Markdown 連結

每個透過 Apidog 發布的線上文件頁面都有 Markdown 版本。你可以：

在任何文件 URL 後加上「.md」（例如：https://example.apidog.io/page.md）

或在線上文件中點擊「View as Markdown」

具備 Web Browsing 功能的 AI 助理可以使用這些「.md」URL 來擷取簡潔的文件內容。

例如，在 Cursor 中，你可以詢問：「Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client」。

提示格式

提示格式必須遵循所使用 AI 工具的特定規則。例如，在 Cursor 中，URL 必須以 @ 開頭，才會被辨識為上下文。

2. 為無法存取 URL 的 AI 助理複製 Markdown 內容

如果 AI 助理無法透過 URL 存取內容，你需要手動複製並貼上 Markdown 內容。

點擊線上文件中的「Copy Page」按鈕，以 Markdown 格式取得目前頁面內容，然後將其貼到你與 AI 助理的對話中。

範例提示：

「根據此端點定義，請產生 TypeScript client：（在此貼上複製的內容）。」

常見問題

啟用 llms.txt 會影響文件安全性嗎？

不會。 llms.txt 只包含已公開發布的內容。它只是將 HTML 轉換為 Markdown，並不會公開私人或未發布的文件。如果已設定存取控制（密碼、IP 允許清單、電子郵件允許清單等），使用者仍必須通過驗證才能存取 llms.txt 和 Markdown 檔案。

如果我的文件受到密碼、IP 或電子郵件允許清單保護，我還能使用 llms.txt 嗎？

為什麼我在 Apidog App 中看不到 `Copy Page` 按鈕？

我已為 AI 助理啟用 'Web Search' 功能。為什麼它無法透過 URL 讀取網頁內容？

如果 AI 助理無法透過 URL 存取 Markdown 檔案，我該怎麼做？

啟用 llms.txt 後，我還需要做其他事嗎？

如何驗證 llms.txt 是否正常運作？

Ask AI#

Enable MCP (Model Context Protocol)#

Enable Copy Page#

Enable llms.txt#

AI 助理如何使用 llms.txt#

常見問題#

Ask AI

Enable MCP (Model Context Protocol)

Enable Copy Page

Enable llms.txt

AI 助理如何使用 llms.txt

常見問題