隐藏页面示例

隐藏页面的常见用例

此页面已隐藏！它未包含在 docs.json 的导航中，因此只能通过其 URL 访问。

更多信息请参见隐藏页面。

隐藏页面的常见用例

默认情况下，隐藏页面可公开访问，但无法通过导航找到。若需限制对隐藏页面的访问，必须配置认证。

• Beta 文档：可以公开，但不应通过导航被发现的信息。
• AI 工具上下文：如果隐藏页面被索引，AI 工具可将其作为上下文引用。将对用户不太相关、但能帮助 AI 工具提供更准确回答的内容放在隐藏页面中。
• 旧版页面：通过直接链接保留旧内容的可访问性，同时将其从导航菜单中移除。
• 内部工具：记录内部工具、预发布环境 API 或开发流程。

示例

AI 上下文

换行

---
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>