发布文档搜索设置

Apifox 版本需 ≥ 2.6.31

发布文档提供默认的搜索功能，默认的搜索功能目前只能搜索文档/接口的名称和路径。

Apifox 也支持 Algolia 的搜索功能，你只需将 Algolia 中的字段回填到 Apifox 的设置项中，即可启用此功能。

提示

注意：Algolia 可以免费使用，但是有一定限额；如需提升限额，可以使用 Algolia 的付费版，或者申请免费的 Algolia DocSearch 计划。

Algolia 配置流程

登录 Algolia 官网 https://www.algolia.com/，进行注册账号。

注册账号后，进行创建应用。

第一步：数据源选择「上传文件」

将给出的示例代码复制下来，创建为 JSON 文件，然后拖入并上传。

提示

JSON 文件的名字，就是实际的 Index Name，需要回填到 Apifox 的搜索配置表中。

第二步：选择数据的展示，可以随意填。

后面几步可以忽略，直接往下点击“下一步”。

到最后一步，会让你选择构建搜索的方式，忽略即可。

然后在页面中（一般在首页），找到下面的配置项信息，回填到 Apifox 的配置表中，配置完毕后保存即可。

配置项中 Index Name 的值可以在这里找到，也就是你在第一步中上传的 JSON 文件的名字。

配置完毕后，Apifox 会自动将 Algolia 的配置项同步，并启用 Algolia 的搜索功能。

提示

注意：Algolia 可以免费使用，但是有一定限额；如需提升限额，可以使用 Algolia 的付费版，或者申请免费的 Algolia DocSearch 计划。

免费的 Algolia DocSearch 计划

Algolia 提供免费的 DocSearch 计划用于特定目的（如文档搜索），你可以在此申请免费的 Algolia DocSearch 计划。里面需要填入的 Documentation URL 可以填写 Apifox 中公开的文档地址。

当申请成功之后，Algolia 会给你发送邮件，并且在其后台，会收到一条邀请你加入应用程序的消息，点击确认即可。

确认后，请在页面左上角切换到相应应用程序，并将该应用程序的 Application ID 和 Write API Key 填入 Apidog 的相应配置项。请注意，Search API Key 需要在其他位置查找。

要找到免费的 Algolia DocSearch 计划中的 Search API Key，你可以参考以下图文步骤，以获取 Algolia API Key。

同样的，配置项中 Index Name 的值可以在这里找到。