Restic项目REST后端接口详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00465/article/details/148360508

Restic项目REST后端接口详解

Restic是一款高效的备份工具，它支持通过REST API与远程存储后端进行交互。本文将深入解析Restic的REST后端接口规范，帮助开发者理解如何实现与Restic兼容的存储服务。

Restic的REST API支持版本控制，客户端可以通过Accept请求头指定使用的API版本：

服务器会在响应头Content-Type中返回它所支持的最高版本。如果响应头值与请求版本不同，则默认使用API版本1。

接口路径中的{path}表示仓库路径，允许访问多个不同的仓库。默认路径为/，且路径必须以斜杠结尾。

创建仓库
- 方法：POST
- 路径：{path}?create=true
- 功能：初始化创建新仓库
- 成功响应：200 OK（仓库已存在或创建成功）
删除仓库
- 方法：DELETE
- 路径：{path}
- 功能：删除服务器上的仓库
- 可能响应：
  - 200 OK（删除成功）
  - 501 Not Implemented（未实现）
  - 403 Forbidden（权限不足）

Restic将数据分为多种类型，{type}可以是以下值：

列出对象
- 方法：GET
- 路径：{path}/{type}/
API版本1返回简单的文件名数组：
```
["文件1哈希", "文件2哈希"]
```
API版本2返回包含文件名和大小的对象数组：
```
[
  {"name": "文件1哈希", "size": 文件大小},
  {"name": "文件2哈希", "size": 文件大小}
]
```
检查对象存在
- 方法：HEAD
- 路径：{path}/{type}/{name}
- 功能：检查指定对象是否存在
- 成功响应：200 OK（包含Content-Length头）
- 失败响应：404 Not Found
获取对象内容
- 方法：GET
- 路径：{path}/{type}/{name}
- 响应格式：binary/octet-stream
- 功能：返回指定对象内容
- 支持范围请求（Range头），此时返回206 Partial Content
保存对象
- 方法：POST
- 路径：{path}/{type}/{name}
- 请求格式：binary/octet-stream
- 功能：保存请求体内容为指定对象
- 成功响应：200 OK
删除对象
- 方法：DELETE
- 路径：{path}/{type}/{name}
- 功能：删除指定对象
- 成功响应：200 OK