思源笔记开发文档

Appearance

端点 ​

/api/filetree/renameDocByID

接口描述 ​

本接口用于根据文档ID重命名文档。与renameDoc接口不同，该接口使用文档ID来指定要重命名的文档，而不是文档路径。

重命名文档会更新文档的标题，同时保持文档的所有内容和属性不变。

请求参数 ​

请求体为一个 JSON 对象，包含以下字段：

参数名类型必需描述
idstring是要重命名的文档ID，例如 20210808180117-czj9bvb。
titlestring是新的文档标题。

响应体 ​

成功时，响应体为一个 JSON 对象，包含以下字段：

参数名类型描述
codenumber状态码，0 表示成功。
msgstring错误信息，成功时为空字符串。
datanull此接口无返回数据，成功时为 null。

请求示例 ​

json
{
  "id": "20210808180117-czj9bvb",
  "title": "新文档标题"
}

响应示例 ​

成功响应：

json
{
  "code": 0,
  "msg": "",
  "data": null
}

失败响应（ID不存在）：

json
{
  "code": -1,
  "msg": "加载文档树失败 id [20210808180117-xxxxxx]: 文档块不存在",
  "data": {
    "closeTimeout": 7000
  }
}

错误码 ​

错误码描述
0成功
-1失败，可能原因包括：文档ID不存在、无权限、标题格式无效等

源码定位 ​

后端实现相关的核心逻辑可以在以下文件中找到：

  • 路由定义：siyuan/kernel/api/router.go（路由 /api/filetree/renameDocByID）
  • API 处理函数：siyuan/kernel/api/filetree.go（函数 renameDocByID）
  • 模型层实现：siyuan/kernel/model/file.go（函数 RenameDoc）

注意：这是一个社区维护的文档，可能与官方最新版本存在差异。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电

© 2024 社区贡献者们. 本文档源码

本文档非官方出品，主要由 AI 辅助编写，不保证绝对准确。如有疑问，请以 kernel/api/bazaar.go 中的源码为准。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电 本文档非官方出品，主要由 AI 辅助编写，不保证绝对准确。如有疑问，请以 kernel/api/ 中的源码为准。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电