Skip to main content
分页返回当前站点可见的开发者文档,可用于搜索、索引或在客户端自行构建导航。列表当前包含每篇文档的 content 和嵌套父级信息,响应可能较大。

接口概览

查询参数

当前列表接口不支持 alias 或 parent_id 过滤。已知 alias 时直接调用文档详情;构建树形导航时一次分页拉取后,使用每项 parent.id 在客户端分组。

请求示例

响应结构

列表使用 DocumentIndexSerializer,当前会返回模型字段及嵌套关系;关联 API 文档还可能带 api_method。字段可能向后兼容地增加,客户端应按需读取。需要 children、解析后的内容语言和内容哈希时,使用详情接口。 对于关联源文档的公开记录,content_source 提供源文档标识、源内容哈希、所请求的语言、翻译更新时间及 ready、stale、missing、missing_source 或 ambiguous 状态;其他记录该字段为 null。ready 时的 content_hash 对应该语言译文。正文仍按原有规则展示,包括缺少译文时的语言回退;需要同步文档的客户端应同时检查状态和哈希,不能仅凭正文非空判断已更新。

使用建议

  • 响应含正文,批量同步时使用分页并设置合理超时,不要并发抓取同一页。
  • alias 是公开页面 URL 的稳定标识;已知 alias 时直接请求 /api/v1/documents/{alias}。
  • 当前接口无法按父级服务端过滤;构建导航时在客户端按 parent.id 分组。

相关接口