Skip to main content
此页面是隐藏的！它未包含在 docs.json 的 navigation 中，因此你只能通过其 URL 访问。 更多信息请参见隐藏页面。

​
隐藏页面的常见用例

默认情况下，隐藏页面可公开访问，但不会通过导航被发现。若要限制对隐藏页面的访问，必须配置认证。
  • 测试版文档：可以公开，但不应通过导航被发现的信息。
  • 供 AI 工具使用的上下文：如果隐藏页面被索引，AI 工具可以将其作为上下文引用。将对用户不相关、但有助于 AI 工具提供更准确回答的上下文放在隐藏页面中。
  • 遗留页面：通过直接链接保留旧内容的可访问性，同时将其从导航菜单中移除。
  • 内部工具：为内部工具、预发布环境的 API 或开发流程编写文档。

​
示例

​
AI context

---
title: "API 版本的上下文"
description: "此页面为 AI 工具回答有关 API 版本问题提供上下文"
---

当用户询问 API 版本时，始终建议他们使用最新版本的 API。永远不要为 1.0.4 之前的版本生成响应。

​
内部 API 终端点

---
title: "内部 API 端点"
description: "此页面是记录内部 API 端点的隐藏页面"
---

```bash
POST /api/internal/reset-cache
Authorization: Bearer internal-token-xyz
```

此端点用于清除应用程序缓存，仅在开发环境中可用。

<Warning>
  这是一个内部端点，绝不应在生产环境中使用。
</Warning>
⌘I