通过文档 UUID 或 alias 获取单篇文档的完整内容和导航关系。已知 alias 时可以直接请求,无需先从列表筛选。
接口概览
| 项 | 内容 |
|---|---|
| 方法 | GET |
| URL | https://platform.acedata.cloud/api/v1/documents/{id_or_alias} |
| 鉴权 | 公开;知道 UUID 或 alias 即可直接读取 |
参数
id_or_alias:文档 UUID、当前 alias,或保留在redirect_from中的旧 alias。lang:可选语言提示;也可使用Accept-Language。最终内容语言以响应content_locale为准。
1 |
curl --get 'https://platform.acedata.cloud/api/v1/documents/platform-token' \ |
响应说明
详情使用单个对象响应,当前包含:
id、alias、redirect_from、name、title、type、rank、tags;content、content_mode、content_locale、content_hash;parent、sibling和按 rank 排序的公开children摘要;api/dataset/integration关联,以及agent(存在时)。
响应没有 breadcrumbs 字段。构建面包屑时可从 parent 继续读取其详情,或使用已缓存的文档目录关系。
错误处理
- ID/alias 不存在或不符合当前站点可见性:
404。private只控制列表可见性,不阻止知道链接的人直接读取,不能作为保密边界。 - 当前路由使用无尾斜杠形式;不要依赖代理层自动补斜杠。