AI 功能

通过 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 部分了解有关此功能的更多信息。

启用 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。

启用复制页面

启用后，你的文档中会出现一个 “Copy page” 按钮，允许用户将当前页面复制为 Markdown 格式，非常适合粘贴到 AI 对话中。

启用 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 助手的对话中。

示例提示：

“Based on this endpoint definition, please generate a TypeScript client: (paste the copied content here).”

常见问题

启用 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#

启用 MCP（Model Context Protocol）#

启用复制页面#

启用 llms.txt#

AI 助手如何使用 llms.txt#

常见问题#

Ask AI

启用 MCP（Model Context Protocol）

启用复制页面

启用 llms.txt

AI 助手如何使用 llms.txt

常见问题