你可能花了很多时间打磨 API 文档的内容，但当在搜索引擎中搜索相关关键词时，你的文档却很难出现在搜索结果中。其实并不是内容写得不好，而是文档站缺乏必要的 SEO 优化。
Apifox 发布的在线文档站，默认就做了不少优化工作，包括 sitemap 生成、robots 文件管理、语义化的 URL，以及每页可自定义的 metadata 标签。这些都是搜索引擎在抓取和收录时极为关键的信息。
除了这些默认优化，你还可以根据实际需求进行更精细的 SEO 设置。整套功能分成两个层面：页面级设置 和站点级设置。页面级让你能针对单个接口文档或 Markdown 页面做精细优化，站点级则是对整个文档站进行统一管理。
我们下文就来看看怎么具体设置，如果你的 Apifox 版本较旧，建议先更新到最新版本。
从单个页面开始优化
页面级的 SEO 设置最直观，也最容易上手。在任何接口文档或 Markdown 文档页面的右上方，你都能看到「SEO 设置」图标，点击就能打开设置面板。
最基础的是自定义 URL 功能。系统默认生成的地址通常包含一小串数字，比如 https://{your-domain.com}/5702007m0，这种地址不太好记，也没有语义信息。但如果你把这个"获取宠物信息"的接口 URL 设置为 get-pet-info，最终地址就变成了 https://{your-domain.com}/get-pet-info，一看就知道是什么功能。
对于 Meta Title 和 Meta Description 的设置。Meta Title 就是搜索结果中显示的蓝色标题，直接影响搜索排名和点击率。Meta Description 是你为页面提供的描述文字，搜索引擎可能会在搜索结果中使用它，也可能根据用户搜索的关键词从页面内容中提取更相关的片段。不过设置一个好的 Meta Description 仍然很重要，因为当搜索引擎采用它时，就能帮助用户更好地了解页面内容。
你还可以填写 Keywords 关键词，虽然现在搜索引擎对 keywords 的依赖程度没有以前那么高，但仍然有助于搜索引擎理解页面主题。比如对于"获取宠物信息"接口，你可以填写"宠物信息， API 接口， 宠物数据， REST API"这样的关键词。
对于有更深入 SEO 需求的用户，还可以通过「自定义 Metadata」 添加任意的 meta 标签。这个功能使用 JSON 格式，比如你可以添加 {"name": "robots", "content": "noindex"} 来告诉搜索引擎不要索引某个页面，或者添加 {"property": "og:image", "content": "图片链接"} 来设置分享时的缩略图。系统会自动把这些配置转换成标准的 HTML meta 标签。
整站级别的统一管理
除了单页优化，Apifox 也支持对整个文档站进行统一的 SEO 配置。在发布在线文档时，你可以通过「SEO 设置」模块来管理这些全局设置。
全局 Metadata 是最重要的功能之一。你可以配置适用于整站的通用 meta 标签，所有页面都会继承这些设置。更重要的是，这个功能支持内置变量，让你不用为每个页面重复填写相同信息。
比如你可以这样配置：
JSON
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]这里的 {{PAGE_TITLE}} 和 {{SITE_NAME}} 会自动替换成实际的页面标题和站点名称。系统支持多个内置变量，包括页面标题、页面 URL、站点名称、站点图标、默认描述和关键词。
需要注意的是，配置有优先级：页面级设置会覆盖全局设置，全局设置会覆盖系统默认值。这样既保证了灵活性，又避免了配置冲突。
robots.txt 文件的管理也很简单。这个文件相当于给搜索引擎爬虫的使用说明，告诉它们哪些页面可以抓取。Apifox 会自动生成一个基础的 robots.txt，内容包括允许所有爬虫访问所有页面，并指向 sitemap 文件的位置。
如果你有某些页面不想被搜索引擎收录，可以通过在全局 Metadata 或页面级设置中添加 {"name": "robots", "content": "noindex"} 来实现。
sitemap.xml 功能默认是开启的，因为对 SEO 帮助很大。这个文件相当于网站的目录，列出了所有页面的地址（也称为站点地图）。搜索引擎爬虫有了这个目录，就能更系统、更高效地抓取你的内容。启用后，文件可以通过 https://{your-domain.com}/sitemap.xml 访问。
如果你因为某些原因需要关闭这个功能，系统会停止生成 sitemap 文件，同时也会自动调整robots.txt文件，移除其中的 sitemap 引用。
当你需要修改已发布文档的 URL 时，「文档重定向规则」功能就派上用场了。比如文档地址改了，或者想优化地址结构，如果直接改 URL，用户访问原来的地址就会看到 404 错误。
通过设置重定向规则，访问旧地址的用户会自动跳转到新地址，既保证了用户体验，也避免了 SEO 权重的流失。
URL 命名的两种策略
在 URL 设置方面，系统会根据你是否设置了自定义 URL 来采用不同策略。如果你设置了自定义 URL，系统就直接使用你设置的值，比如设置为 api-overview，最终地址就是 https://{your-domain.com}/api-overview。
如果没有设置自定义 URL，系统提供两种自动生成规则。
第一种是标题加 ID 的组合，比如 https://{your-domain.com}/SEO-设置-5702007m0，这种方式既有语义信息，又保证了唯一性。搜索引擎能从 URL 理解页面内容，用户看到地址也知道大概内容。
第二种是只保留 ID，比如 https://{your-domain.com}/5702007m0，更简洁但缺少语义信息。
从 SEO 角度来说，第一种方式更有优势，因为搜索引擎会把 URL 中的关键词作为排名因素之一。不过如果你的文档站已经有足够高的权重和知名度，URL 的语义化重要性就会相对降低。对于大多数文档站来说，选择包含关键词的 URL 仍然是更好的选择。如果你更看重简洁性，或者文档结构比较复杂，第二种方式也是合理选择。
配置的实际建议
在实际操作时，建议先从全局配置开始，设置好全局 Metadata，建立整个文档站的 SEO 基础框架。这一步做好了，所有页面都会有基本的 SEO 配置。
然后重点优化那些你特别希望获得流量的核心页面，比如最常用的几个 API 接口，或者新用户最容易接触到的快速开始文档。为这些页面单独进行页面级优化，设置更精准的标题、描述和关键词。
在 URL 规则选择上，如果团队更注重 SEO 效果，建议选择包含标题的 URL 规则；如果更看重简洁性，可以选择纯 ID 的规则。
还要注意一点：SEO 是个长期过程，不要指望设置完就立刻看到效果。搜索引擎排名不仅取决于页面本身的优化，还受到很多其他因素影响，比如网站的整体权重、其他网站对你的链接引用（外链）、用户的行为数据等等。即使你把页面级和站点级的 SEO 都设置得很完善，也需要时间让搜索引擎发现、抓取和评估你的内容。
我们需要根据搜索数据和用户反馈持续优化，定期查看哪些页面的搜索表现比较好，哪些需要改进。同时也要关注文档内容本身的质量，毕竟再好的 SEO 设置，也比不上真正有价值的内容。
总结
通过 Apifox 的这套完整 SEO 功能，你可以让 API 文档在搜索引擎中获得更好的表现。从页面级的精细优化到站点级的统一管理，从自定义 URL 到 metadata 设置，从 sitemap 生成到重定向规则，这些功能覆盖了文档站 SEO 的各个方面。如果想要了解更详细的内容，可以访问 Apifox 帮助文档的 SEO 设置模块。
如果你想深入了解搜索引擎优化的更多知识，可以参考以下文档：
欢迎大家继续对 Apifox 提出使用反馈和优化意见，有任何问题可以在 Apifox 用户群与我们交流沟通。