siyuan/API.md at aa704af6e441eaffbdc0c77d04f6d23f41c958d6

Andreas/siyuan

Fork 0

mirror of https://github.com/siyuan-note/siyuan.git synced 2025-12-21 09:00:12 +01:00

Liang Ding c929f2989c

📝 API 上传资源文件建议

2021-10-24 21:34:35 +08:00

10 KiB

Raw Blame History

规范
- 参数和返回值
- 鉴权
笔记本
文档
资源文件
- 上传资源文件
属性
- 设置块属性
- 获取块属性
SQL
- SQL 查询
模板
- 渲染模板
导出
- 导出 Markdown 文本
系统
Webhook

规范

参数和返回值

端点：http://127.0.0.1:6806
均是 POST 方法
需要带参的接口，参数为 JSON 字符串，放置到 body 里，标头 Content-Type 为 application/json
返回值
```
{
  "code": 0,
  "msg": "",
  "data": {}
}
```
- code：非 0 为异常情况
- msg：正常情况下是空字符串，异常情况下会返回错误文案
- data：可能为 {}、[] 或者 NULL，根据不同接口而不同

鉴权

在 设置 - 关于 里查看 API token，请求标头：Authorization: Token xxx

笔记本

列出笔记本

/api/notebook/lsNotebooks
不带参

返回值

{
  "code": 0,
  "msg": "",
  "data": {
    "notebooks": [
      {
        "closed": false,
        "id": "20210817205410-2kvfpfn",
        "name": "测试笔记本"
      },
      {
        "closed": true,
        "id": "20210831090520-7dvbdv0",
        "name": "测试笔记本2"
      }
    ]
  }
}

打开笔记本

/api/notebook/openNotebook

参数

{
  "notebook": "20210831090520-7dvbdv0"
}

notebook：笔记本 ID

返回值

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

关闭笔记本

/api/notebook/closeNotebook

参数

{
  "notebook": "20210831090520-7dvbdv0"
}

notebook：笔记本 ID

返回值

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

重命名笔记本

/api/notebook/renameNotebook

参数

{
  "notebook": "20210831090520-7dvbdv0",
  "name": "笔记本的新名称"
}

notebook：笔记本 ID

返回值

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

创建笔记本

/api/notebook/createNotebook
参数
```
{
  "name": "笔记本的名称"
}
```

返回值

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

删除笔记本

/api/notebook/removeNotebook

参数

{
  "notebook": "20210831090520-7dvbdv0"
}

notebook：笔记本 ID

返回值

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

获取笔记本配置

/api/notebook/getNotebookConf

参数

{
  "notebook": "20210817205410-2kvfpfn"
}

notebook：笔记本 ID

返回值

{
  "code": 0,
  "msg": "",
  "data": {
    "box": "20210817205410-2kvfpfn",
    "conf": {
      "name": "测试笔记本",
      "closed": false,
      "refCreateSavePath": "",
      "createDocNameTemplate": "",
      "dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
      "dailyNoteTemplatePath": ""
    },
    "name": "测试笔记本"
  }
}

保存笔记本配置

/api/notebook/setNotebookConf

参数

{
  "notebook": "20210817205410-2kvfpfn",
  "conf": {
      "name": "测试笔记本",
      "closed": false,
      "refCreateSavePath": "",
      "createDocNameTemplate": "",
      "dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
      "dailyNoteTemplatePath": ""
    }
}

notebook：笔记本 ID

返回值

{
  "code": 0,
  "msg": "",
  "data": {
    "name": "测试笔记本",
    "closed": false,
    "refCreateSavePath": "",
    "createDocNameTemplate": "",
    "dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
    "dailyNoteTemplatePath": ""
  }
}

文档

通过 Markdown 创建文档

/api/filetree/createDocWithMd
参数
```
{
  "notebook": "20210817205410-2kvfpfn",
  "path": "/foo/bar",
  "markdown": ""
}
```
- notebook：笔记本 ID
- path：文档路径，需要以 / 开头，中间使用 / 分隔层级
- markdown：GFM Markdown 内容
返回值
```
{
  "code": 0,
  "msg": "",
  "data": "20210914223645-oj2vnx2"
}
```
- data：创建好的文档 ID
- 如果使用同一个 path 重复调用该接口，不会覆盖已有文档，而是新建随机数结尾的文档

重命名文档

/api/filetree/renameDoc

参数

{
  "notebook": "20210831090520-7dvbdv0",
  "path": "/20210902210113-0avi12f.sy",
  "title": "文档新标题"
}

notebook：笔记本 ID
path：文档路径

返回值

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

删除文档

/api/filetree/removeDoc

参数

{
  "notebook": "20210831090520-7dvbdv0",
  "path": "/20210902210113-0avi12f.sy"
}

notebook：笔记本 ID
path：文档路径

返回值

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

移动文档

/api/filetree/moveDoc

参数

{
  "fromNotebook": "20210831090520-7dvbdv0",
  "fromPath": "/20210917220056-yxtyl7i.sy",
  "toNotebook": "20210817205410-2kvfpfn",
  "toPath": "/"
}

fromNotebook：源笔记本 ID
fromPath：源路径
toNotebook：目标笔记本 ID
toPath：目标路径

返回值

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

根据路径获取人类可读路径

/api/filetree/getHPathByPath

参数

{
  "notebook": "20210831090520-7dvbdv0",
  "path": "/20210917220500-sz588nq/20210917220056-yxtyl7i.sy"
}

notebook：笔记本 ID
path：路径

返回值

{
  "code": 0,
  "msg": "",
  "data": "/foo/bar"
}

资源文件

上传资源文件

/api/asset/upload
参数为 HTTP Multipart 表单
- assetsDirPath：资源文件存放的文件夹路径，实参有以下三种情况
  1. "/assets/"：工作空间/data/assets 文件夹
  2. "/测试笔记本/assets/"：测试笔记本下的 assets 文件夹
  3. "/测试笔记本/foo/assets/"：测试笔记本下 foo 文件夹下的 assets 文件夹
  建议用第一种，统一存放到工作空间资源文件夹下。
- file[]：上传的文件列表
返回值
```
{
  "code": 0,
  "msg": "",
  "data": {
    "errFiles": [""],
    "succMap": {
      "foo.png": "assets/foo-20210719092549-9j5y79r.png"
    }
  }
}
```
- errFiles：处理时遇到错误的文件名
- succMap：处理成功的文件，key 为上传时的文件名，value 为 assets/foo-id.png，用于将已有 Markdown 内容中的资源文件链接地址替换为上传后的地址

属性

设置块属性

/api/attr/setBlockAttrs

参数

{
  "id": "20210912214605-uhi5gco",
  "attrs": {
      "custom-attr1": "line1\nline2"
  }
}

id：块 ID
attrs：块属性，自定义属性必须以 custom- 作为前缀

返回值

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

获取块属性

/api/attr/getBlockAttrs
参数
```
{
  "id": "20210912214605-uhi5gco"
}
```
- id：块 ID

返回值

{
  "code": 0,
  "msg": "",
  "data": {
    "custom-attr1": "line1\nline2",
    "id": "20210912214605-uhi5gco",
    "title": "PDF 标注双链演示",
    "type": "doc",
    "updated": "20210916120715"
  }
}

SQL

SQL 查询

/api//query/sql

参数

{
  "stmt": "SELECT * FROM blocks WHERE content LIKE'%content%' LIMIT 7"
}

stmt：SQL 脚本

返回值

{
  "code": 0,
  "msg": "",
  "data": [
    { "列": "值" }
  ]
}

模板

渲染模板

/template/render

导出

导出 Markdown 文本

/api/export/exportMdContent
参数
```
{
  "id": ""
}
```
- id：要导出的文档块 ID

返回值

{
  "code": 0,
  "msg": "",
  "data": {
      "hPath": "/0 请从这里开始",
      "content": "## 🍫 内容块\n\n在思源中，唯一重要的核心概念是..."
  }
}

hPath：人类可读的路径
content：Markdown 内容

系统

获取启动进度

/api/system/bootProgress
不带参

返回值

{
  "code": 0,
  "msg": "",
  "data": {
      "details": "Finishing boot...",
      "progress": 100
  }
}

获取系统版本

/api/system/version
不带参

返回值

{
  "code": 0,
  "msg": "",
  "data": "1.3.5"
}

获取系统当前时间

/api/system/currentTime
不带参

返回值

{
  "code": 0,
  "msg": "",
  "data": 1631850968131
}

data: 精度为毫秒

Webhook

TBD

https://ld246.com/article/1627956688432

10 KiB Raw Blame History Unescape Escape

规范