列出笔记¶
- 接口地址:
/api/note/list
- HTTP请求方式
GET
- 请求参数
label (query, optional): 标签/视图,如 inbox / starred / important / archive
page / page_count (query, optional): 分页
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/note/list"
响应示例:
JSON:
{ }
创建笔记¶
- 接口地址:
/api/note/create
- HTTP请求方式
POST
- 请求参数
title (form, optional): 标题
content (form, optional): 内容
labels (form, optional): 标签 ID 逗号分隔
is_inbox / is_important / is_starred (form, optional): true/false
title 与 content 至少一项
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/create" -d "title=标题&content=内容"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }
获取笔记详情¶
- 接口地址:
/api/note/detail/:id
- HTTP请求方式
GET
- 请求参数
id (path): 笔记 ID
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/note/detail/:id"
响应示例:
JSON:
{ }
删除笔记¶
- 接口地址:
/api/note/delete
- HTTP请求方式
POST
- 请求参数
id (form, required): 笔记 ID,多个逗号分隔
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/delete"
响应示例:
JSON:
{ }
update note¶
- 接口地址:
/api/note/update
- HTTP请求方式
POST
- 请求参数
id (form, required): 笔记 ID
title (form, optional): 标题
content (form, optional): 内容
其他字段见实现
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/update" -d "id=1&title=新标题"
响应示例:
JSON:
{ "code": 0, "message": "OK" }
归档笔记¶
- 接口地址:
/api/note/archive
- HTTP请求方式
POST
- 请求参数
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/archive"
响应示例:
JSON:
{ }
取消归档笔记¶
- 接口地址:
/api/note/unarchive
- HTTP请求方式
POST
- 请求参数
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/unarchive"
响应示例:
JSON:
{ }
设置笔记星标状态¶
- 接口地址:
/api/note/starredstate
- HTTP请求方式
POST
- 请求参数
id (form, required): 笔记 ID
starred (form, required): true/false
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/starredstate"
响应示例:
JSON:
{ }
设置笔记重要状态¶
- 接口地址:
/api/note/importantstate
- HTTP请求方式
POST
- 请求参数
id (form, required): 笔记 ID
important (form, required): true/false
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/note/importantstate"
响应示例:
JSON:
{ }