跳转到内容

图章 API

8 endpoints.

获取该档案中至少含有一个图章的页面

Section titled “获取该档案中至少含有一个图章的页面”
GEThttp://localhost:3000/api/archives/{id}/stamps

获取该档案中至少含有一个图章的页面。

路径参数

idstring必填
档案 ID。

响应

200成功响应
{
  "result": [
    ""
  ]
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/archives/{id}/stamps/{index}

获取链接到该页面的图章。

路径参数

idstring必填
档案 ID。
indexinteger必填
档案的页码。

响应

200成功响应
{
  "result": [
    {
      "content": "Lorem ipsum dolore",
      "position": "12,34"
    }
  ]
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

填写你自己的实例地址,请求由浏览器直接发往该地址。

PUThttp://localhost:3000/api/archives/{id}/stamps/{index}

在给定坐标处向该页面添加一个新图章。

路径参数

idstring必填
档案 ID。
indexinteger必填
档案的页码。

查询参数

contentstring可选
图章文本。
positionstring可选
图章在页面中的位置。

响应

200成功响应
{
  "operation": "add_stamp",
  "stamp_id": "",
  "success": 0
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

DELETEhttp://localhost:3000/api/stamps/{id}

从某个档案中移除一个图章。

路径参数

idstring必填
图章 ID。

响应

200成功响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}
423该图章当前被锁定,无法修改
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/stamps/{id}

从某个档案获取一个图章。

路径参数

idstring必填
图章 ID。

响应

200成功响应
{
  "content": "Lorem ipsum dolore",
  "position": "12,34"
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}
423该图章当前被锁定,无法修改
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

填写你自己的实例地址,请求由浏览器直接发往该地址。

PUThttp://localhost:3000/api/stamps/{id}

更新某个档案中的一个图章。

路径参数

idstring必填
图章 ID。

查询参数

contentstring可选
图章文本。
positionstring可选
图章在页面中的位置。

响应

200成功响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}
400错误响应
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}
423该图章当前被锁定,无法修改
{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。

GEThttp://localhost:3000/api/tankoubons/{id}/stamps/{page}

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 tank_stamps_by_page,位于 crates/lanrurugi-api/src/stamps.rs:58。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/stamps.rs:52 处的 handler。

该响应没有示例数据。

填写你自己的实例地址,请求由浏览器直接发往该地址。

PUThttp://localhost:3000/api/tankoubons/{id}/stamps/{page}

尚未在此参考中描述。这个端点会被列出,是因为服务端确实注册了它,但它的请求与响应形状还没有写下来。

对应的 handler 是 tank_add_stamp,位于 crates/lanrurugi-api/src/stamps.rs:72。

响应

200该端点已响应;其确切结构尚未记录,见 crates/lanrurugi-api/src/stamps.rs:52 处的 handler。

该响应没有示例数据。

该端点需要管理员令牌:访客(只读)令牌会被服务端拒绝。

填写你自己的实例地址,请求由浏览器直接发往该地址。