此页面为隐藏页面!它未被纳入 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>