SEO 设置

Apifox 为 API 文档提供了 SEO 设置功能，你可以针对搜索引擎来优化 API 文档，吸引更多的浏览量。

Apifox 版本号需 >=2.6.25

在 Apifox 的接口文档、Markdown 文档页面，点击右侧的「SEO 设置」icon，即可打开 SEO 设置面板。

自定义 URL（Slug）

你可以对将要发布出去的接口、Markdown 文档、目录设置你想要的 Slug，使其对搜索引擎更加友好。当你设置了 Slug 之后，在分享的 API 文档中，对应页面的 URL 为 https://your-domain.com/{slug}。

提示

如果你在发布文档时配置了自定义域名，那么 「自定义 URL」里的 {{Baes URL}} 最终会显示为指定的自定义域名。

Meta Data

你可以通过设置以下字段，针对搜索引擎优化 API 在线文档网页：

• Meta Title

  设置网页的标题，显示在搜索引擎结果页面中。

• Meta Description

  设置网页的简短描述，显示在搜索引擎结果页面中。

• Keywords

  为网页设置目标关键词，有助于提高网站的搜索引擎排名。

URL 规则

在发布文档设置的页面，可以跳转到「项目设置」查看当前的 URL 规则。

点击后，会跳转到 「URL 规则」页面，你可以在这里自定义相关规则。

提示

• 对于新发布的文档，修改了 URL 规则时，系统会自动加重定向
• 对于旧有数据，更改 resourceKey 规范时，系统会自动加重定向

因为系统会自动加重定向，所以你在这里设置的规则，都不会出现在 「发布文档设置 -> 文档重定向规则」的表格中。

重定向配置

如果你需要更改文档中的现有 Slug，为了确保用户仍能访问正确的文档，避免出现失效链接，你可以在「发布文档设置 -> 文档重定向规则」页面设置重定向规则。

在这里，你可以设置多个重定向规则，当用户访问旧的 Slug 时，系统会自动重定向到新的 Slug。