/openapi.json

default

▼
GET /api/v1/keys
获取所有键
响应
状态码 描述 数据类型
200 成功获取所有键 KeysResponse
GET /api/v1/keys/{key}
获取键值
参数
名称 位置 类型 必须 描述
key path string 是 要获取的键
响应
状态码 描述 数据类型
200 成功获取值 KeyValueResponse
404 键不存在 ErrorResponse
PUT /api/v1/keys/{key}
设置键值
参数
名称 位置 类型 必须 描述
key path string 是 要设置的键
请求体
{
  "value": "string",
  "encoding": "base64" // 可选
}
响应
状态码 描述 数据类型
200 成功设置值 SuccessResponse
400 请求格式错误 ErrorResponse
DELETE /api/v1/keys/{key}
删除键值
参数
名称 位置 类型 必须 描述
key path string 是 要删除的键
响应
状态码 描述 数据类型
200 成功删除值 SuccessResponse
404 键不存在 ErrorResponse
POST /api/v1/batch
批量操作
请求体
[
  {
    "operation": "put",
    "key": "string",
    "value": "string",
    "encoding": "base64" // 可选
  },
  {
    "operation": "delete",
    "key": "string"
  }
]
响应
状态码 描述 数据类型
200 成功执行批量操作 SuccessResponse
400 请求格式错误 ErrorResponse
GET /api/v1/stats
获取数据库统计信息
响应
状态码 描述 数据类型
200 成功获取统计信息 StatsResponse
POST /api/v1/merge
执行数据库合并操作
响应
状态码 描述 数据类型
200 成功执行合并操作 SuccessResponse

Schemas

▼
KeysResponse
{
  "keys": [
    "string"
  ]
}
KeyValueResponse
{
  "key": "string",
  "value": "string",
  "encoding": "base64" // 可选
}
ValueRequest
{
  "value": "string",
  "encoding": "base64" // 可选
}
BatchOperation
{
  "operation": "put" | "delete",
  "key": "string",
  "value": "string", // 仅 put 操作需要
  "encoding": "base64" // 可选
}
SuccessResponse
{
  "success": true
}
ErrorResponse
{
  "error": "string"
}
StatsResponse
{
  "key_num": 0,
  "data_file_num": 0,
  "reclaimable_size": 0,
  "disk_size": 0
}