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