📝 API

2025-05-02 19:59:08 +08:00 · 2021-09-17 11:38:54 +08:00 · 2021-09-17 11:38:54 +08:00 · 2088a09b59
commit 2088a09b59
parent 07c0f5afbf
1 changed files with 212 additions and 52 deletions
--- a/API.md
+++ b/API.md
@ -8,8 +8,7 @@
    * [重命名笔记本](#重命名笔记本)
    * [删除笔记本](#删除笔记本)
    * [获取笔记本配置](#获取笔记本配置)
-* [SQL](#SQL)
-  * [SQL 查询](#sql-查询)
+    * [保存笔记本配置](#保存笔记本配置)
 * [文档](#文档)
    * [通过 Markdown 创建文档](#通过-markdown-创建文档)
    * [重命名文档](#重命名文档)
@ -25,6 +24,8 @@
    * [搜索引用块](#搜索引用块)
    * [搜索嵌入块](#搜索嵌入块)
    * [搜索块](#搜索块)
+* [SQL](#SQL)
+  * [SQL 查询](#sql-查询)
 * [模板](#模板)
    * [渲染模板](#渲染模板)
 * [导出](#导出)
@ -88,47 +89,180 @@ https://ld246.com/article/1627956688432

 ### 打开笔记本

-/notebook/openNotebook
-
-### 关闭笔记本
-
-/notebook/closeNotebook
-
-### 重命名笔记本
-
-/notebook/renameNotebook
-
-### 删除笔记本
-
-/notebook/removeNotebook
-
-### 获取笔记本配置
-
-/notebook/getNotebookConf
-
-## SQL
-
-### SQL 查询
-
-* `/api//query/sql`
+* `/api/notebook/openNotebook`
 * 参数

  ```json
  {
-    "stmt": "SELECT * FROM blocks WHERE content LIKE'%content%' LIMIT 7"
+    "notebook": "20210831090520-7dvbdv0"
  }
  ```

-    * `stmt`：SQL 脚本
+    * `notebook`：笔记本 ID
 * 返回值

  ```json
  {
    "code": 0,
    "msg": "",
-    "data": [
-      { "列": "值" }
-    ]
+    "data": null
+  }
+  ```
+
+### 关闭笔记本
+
+* `/api/notebook/closeNotebook`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210831090520-7dvbdv0"
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
+### 重命名笔记本
+
+* `/api/notebook/renameNotebook`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210831090520-7dvbdv0",
+    "name": "笔记本的新名称"
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
+### 新建笔记本
+
+* `/api/notebook/createNotebook`
+* 参数
+
+  ```json
+  {
+    "name": "笔记本的名称"
+  }
+  ```
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+  
+### 删除笔记本
+
+* `/api/notebook/removeNotebook`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210831090520-7dvbdv0"
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
+### 获取笔记本配置
+
+* `/api/notebook/getNotebookConf`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210817205410-2kvfpfn"
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+* 返回值
+
+  ```json
+  {
+    "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`
+* 参数
+
+  ```json
+  {
+    "notebook": "20210817205410-2kvfpfn",
+    "conf": {
+        "name": "测试笔记本",
+        "closed": false,
+        "refCreateSavePath": "",
+        "createDocNameTemplate": "",
+        "dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
+        "dailyNoteTemplatePath": ""
+      }
+  }
+  ```
+
+  * `notebook`：笔记本 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": {
+      "name": "测试笔记本",
+      "closed": false,
+      "refCreateSavePath": "",
+      "createDocNameTemplate": "",
+      "dailyNoteSavePath": "/daily note/{{now | date \"2006/01\"}}/{{now | date \"2006-01-02\"}}",
+      "dailyNoteTemplatePath": ""
+    }
  }
  ```

@ -281,6 +415,32 @@ https://ld246.com/article/1627956688432

 /search/searchBlock

+## SQL
+
+### SQL 查询
+
+* `/api//query/sql`
+* 参数
+
+  ```json
+  {
+    "stmt": "SELECT * FROM blocks WHERE content LIKE'%content%' LIMIT 7"
+  }
+  ```
+
+  * `stmt`：SQL 脚本
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": [
+      { "列": "值" }
+    ]
+  }
+  ```
+  
 ## 模板

 ### 渲染模板