From 2088a09b59f3efed3d66b085ab94918c78a056d2 Mon Sep 17 00:00:00 2001
From: Liang Ding <d@b3log.org>
Date: Fri, 17 Sep 2021 11:38:54 +0800
Subject: [PATCH] :memo: API

---
 API.md | 264 +++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 212 insertions(+), 52 deletions(-)

diff --git a/API.md b/API.md
index 06f685e79..5642dae1c 100644
--- a/API.md
+++ b/API.md
@@ -2,35 +2,36 @@
 * [鉴权](#鉴权)
 * [Webhook](#Webhook)
 * [笔记本](#笔记本)
-  * [列出笔记本](#列出笔记本)
-  * [打开笔记本](#打开笔记本)
-  * [关闭笔记本](#关闭笔记本)
-  * [重命名笔记本](#重命名笔记本)
-  * [删除笔记本](#删除笔记本)
-  * [获取笔记本配置](#获取笔记本配置)
+    * [列出笔记本](#列出笔记本)
+    * [打开笔记本](#打开笔记本)
+    * [关闭笔记本](#关闭笔记本)
+    * [重命名笔记本](#重命名笔记本)
+    * [删除笔记本](#删除笔记本)
+    * [获取笔记本配置](#获取笔记本配置)
+    * [保存笔记本配置](#保存笔记本配置)
+* [文档](#文档)
+    * [通过 Markdown 创建文档](#通过-markdown-创建文档)
+    * [重命名文档](#重命名文档)
+    * [删除文档](#删除文档)
+* [资源文件](#资源文件)
+    * [上传资源文件](#上传资源文件)
+* [属性](#属性)
+    * [设置块属性](#设置块属性)
+    * [获取块属性](#获取块属性)
+* [搜索](#搜索)
+    * [搜索标签](#搜索标签)
+    * [搜索模板](#搜索模板)
+    * [搜索引用块](#搜索引用块)
+    * [搜索嵌入块](#搜索嵌入块)
+    * [搜索块](#搜索块)
 * [SQL](#SQL)
   * [SQL 查询](#sql-查询)
-* [文档](#文档)
-  * [通过 Markdown 创建文档](#通过-markdown-创建文档)
-  * [重命名文档](#重命名文档)
-  * [删除文档](#删除文档)
-* [资源文件](#资源文件)
-  * [上传资源文件](#上传资源文件)
-* [属性](#属性)
-  * [设置块属性](#设置块属性)
-  * [获取块属性](#获取块属性)
-* [搜索](#搜索)
-  * [搜索标签](#搜索标签)
-  * [搜索模板](#搜索模板)
-  * [搜索引用块](#搜索引用块)
-  * [搜索嵌入块](#搜索嵌入块)
-  * [搜索块](#搜索块)
 * [模板](#模板)
-  * [渲染模板](#渲染模板)
+    * [渲染模板](#渲染模板)
 * [导出](#导出)
-  * [导出 Markdown 文本](#导出-markdown-文本)
+    * [导出 Markdown 文本](#导出-markdown-文本)
 * [系统](#系统)
-  * [获取系统版本](#获取系统版本)
+    * [获取系统版本](#获取系统版本)
 
 ---
 
@@ -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": [
+      { "列": "值" }
+    ]
+  }
+  ```
+  
 ## 模板
 
 ### 渲染模板