接口描述
本接口用于根据文档ID删除一个文档。删除操作会将文档移动到系统回收站,不是永久性删除。
警告:删除操作无法撤销,除非通过历史记录恢复。请谨慎使用此API。
请求参数
请求体为一个 JSON 对象,包含以下字段:
参数名 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
string | 是 | 要删除的文档 ID,例如 20200813125239-hbwpz87 。 |
响应体
成功时,响应体为一个 JSON 对象,包含以下字段:
参数名 | 类型 | 描述 |
---|---|---|
code |
number | 状态码,0 表示成功。 |
msg |
string | 错误信息,成功时为空字符串。 |
data |
null | 此接口无返回数据,成功时为 null 。 |
请求示例
{
"id": "20200813125239-hbwpz87"
}
响应示例
成功响应:
{
"code": 0,
"msg": "",
"data": null
}
失败响应(文档不存在):
{
"code": -1,
"msg": "文档不存在",
"data": null
}
错误码
错误码 | 描述 |
---|---|
0 |
成功 |
-1 |
失败,可能原因包括:文档ID格式无效、文档不存在等 |
源码定位
后端实现相关的核心逻辑可以在以下文件中找到:
- 路由定义:
siyuan/kernel/api/router.go
(路由/api/filetree/removeDocByID
) - API 处理函数:
siyuan/kernel/api/filetree.go
(函数removeDocByID
) - 模型层实现:
siyuan/kernel/model/file.go
(函数RemoveDocByID
)
在线测试
警告:此操作会实际删除文档,请确保在测试环境操作或使用不重要的文档ID。
请在下方输入请求 JSON,然后点击"发送请求"按钮。
响应: