github/siyuan
4
0
Fork 0
mirror of https://github.com/siyuan-note/siyuan.git synced 2025-05-02 21:50:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 API

Browse Source
This commit is contained in:
Liang Ding 2021-09-17 12:04:12 +08:00
parent d309da4b79
commit bdf08a6d7d
No known key found for this signature in database
GPG Key ID: 136F30F901A2231D
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API.md
View File

@ -1,5 +1,6 @@
* [参数和返回值](#参数和返回值) * [规范](#规范)
* [鉴权](#鉴权) * [参数和返回值](#参数和返回值)
* [鉴权](#鉴权)
* [笔记本](#笔记本) * [笔记本](#笔记本)
* [列出笔记本](#列出笔记本) * [列出笔记本](#列出笔记本)
* [打开笔记本](#打开笔记本) * [打开笔记本](#打开笔记本)
@ -38,7 +39,9 @@
--- ---
## 参数和返回值 ## 规范
### 参数和返回值
* 端点：`http://127.0.0.1:6806` * 端点：`http://127.0.0.1:6806`
* 均是 POST 方法 * 均是 POST 方法
@ -57,7 +60,7 @@
* `msg`：正常情况下是空字符串，异常情况下会返回错误文案 * `msg`：正常情况下是空字符串，异常情况下会返回错误文案
* `data`：可能为 `{}`、`[]` 或者 `NULL`，根据不同接口而不同 * `data`：可能为 `{}`、`[]` 或者 `NULL`，根据不同接口而不同
## 鉴权 ### 鉴权
在 <kbd>设置 - 关于</kbd> 里查看 API token，请求标头：`Authorization: Token xxx` 在 <kbd>设置 - 关于</kbd> 里查看 API token，请求标头：`Authorization: Token xxx`
@ -577,6 +580,7 @@
"data": false "data": false
} }
``` ```
## Webhook ## Webhook
TBD TBD