端点

/api/repo/getRepoFile

获取本地快照文件内容 (getRepoFile)

此 API 端点 POST /api/repo/getRepoFile 用于获取当前工作空间本地版本库中某个特定快照里的指定文件内容。

该 API 主要用于查看历史版本的文件。

请求体必须是 JSON 格式，包含以下参数：

id (string): 必填。要获取的文件的唯一 ID。此 ID 由快照 ID 和文件路径组成，格式为 <snapshot-id>:<file-path-in-snapshot>。
例如：20240315200000-uvwxyz0:data/documents/20231027100000-abcdefg.sy 表示获取快照 `20240315200000-uvwxyz0` 中的文件 `data/documents/20231027100000-abcdefg.sy`。

请求示例:

json

{
  "id": "20240315200000-uvwxyz0:data/documents/20231027100000-abcdefg.sy"
}

**重要：**此 API 不返回 JSON 数据。成功的请求将直接返回文件的原始二进制数据。

响应头中的 Content-Type 会根据文件的实际类型自动设置（例如 image/png, application/json, text/plain; charset=utf-8 等）。如果无法识别文件类型，则默认为 application/octet-stream。

如果发生错误（例如文件 ID 无效、快照不存在、读取文件失败等），将返回标准的 JSON 错误响应：

json

{
  "code": -1, // 或其他非零错误码
  "msg": "具体的错误信息",
  "data": null
}

您可以在下方输入文件的 ID 进行在线测试。

**注意：**由于此 API 直接返回文件内容，在线测试器可能无法直接显示非文本文件的内容（如图片、压缩包等）。浏览器可能会尝试下载文件或显示乱码。对于文本文件（如 .sy, .md, .txt, .json），通常可以正常显示。

API Token:
Endpoint:
Method:
Parameters (JSON):

发送请求 (尝试显示文本) 发送请求 (尝试下载)

无法直接显示，尝试下载文件。

思源笔记 API 文档 | 最后更新时间：