文档搜索

了解如何将 Apidog 与 Algolia 集成，以增强 API 文档的搜索功能。

默认情况下，已发布的 API 文档包含内置搜索功能，允许用户按名称或路径搜索端点或文档。

此外，Apidog 提供与 Algolia 的集成，以增强搜索能力。要使用此功能，你需要启用它并完成所需配置。

需要 Apidog 版本 v2.6.31 或更高版本。

发布文档后，你可以在侧边栏中导航到 Publish Docs Site 选项卡，然后进入 Documentation Search 选项。点击 Edit 按钮填写你的 Algolia Search 详细信息。

将 Algolia 与 Apidog 集成

访问 Algolia website 并注册账户。

注册后，登录你的 Algolia 账户。

登录后，在 Algolia 仪表板中创建一个新应用。

点击Upload a File上传数据。

TIP

为了让初学者更轻松地完成设置，你可以使用提供的示例代码生成一个 JSON 文件。只需将 JSON 文件拖放到 Algolia 中即可。该 JSON 文件的名称将作为你的 Index Name，后续在 Apidog 的文档搜索配置中会用到。

设计你的搜索显示方式。

点击Next继续，直到到达最后一步。

在最后一步，系统会询问你希望如何构建搜索前端。你可以跳过此选项。

导航到 Algolia Settings -> API Keys 页面，获取你的应用配置详情。

Index Name将在此处显示：

复制这些配置详情，并填写到 Apidog 的文档搜索设置中。

在 Apidog 中填写所需配置详情后，保存设置以启用增强搜索功能。

TIP

虽然 Algolia 可以免费使用，但其使用量有限制。你可以升级到付费计划以获得更高限制，或申请免费的 Algolia DocSearch 计划。

如果你达到免费计划的限制，将在 Apidog 中看到通知：

Ask AI 功能使用户能够直接在你的文档搜索中体验由 AI 驱动的对话式问答。你可以在 Documentation Search 设置中绑定你的 assistant_id 来启用 Ask AI 功能，如下所示。

在 Algolia Ask AI 的允许来源或白名单中，添加你的 Apidog 文档 URL/域名，如下图所示。

Algolia 为特定用途（如文档搜索）提供免费的 DocSearch 计划。你可以在此申请免费的 Algolia DocSearch 计划。在申请表的 Documentation URL 字段中，你可以输入来自 Apidog 的公开 API 文档 URL。

申请成功后，Algolia 会向你发送确认邮件，并且你会在 Algolia 仪表板中收到邀请你加入该应用的消息。点击确认即可加入 Algolia 提供的应用。

确认后，按照上文提到的相同流程获取你的应用配置详情，并将其与你的 Apidog 项目绑定。