From d19ffdce76b5512497be6ec5200d2d99483e5a4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=99=BD=E6=B1=A0?=
 <98259561+whitechi73@users.noreply.github.com>
Date: Sat, 23 Dec 2023 05:18:49 +0800
Subject: [PATCH] =?UTF-8?q?=E6=94=AF=E6=8C=81QQ=E6=94=B6=E8=97=8F=E5=9F=BA?=
 =?UTF-8?q?=E7=A1=80=E6=93=8D=E4=BD=9C?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/api/README.md |   1 +
 docs/api/fav.md    | 138 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 139 insertions(+)
 create mode 100644 docs/api/fav.md

diff --git a/docs/api/README.md b/docs/api/README.md
index 32ee0d5..25c6ce1 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -14,5 +14,6 @@ icon: laptop-code
 - [处理相关](./dispose.md)
 - [群聊相关](./group.md)
 - [文件相关](./file.md)
+- [QQ收藏](./fav.md)
 - [Shamrock相关](./shamrock.md)
 - [其他接口](./other.md)
diff --git a/docs/api/fav.md b/docs/api/fav.md
new file mode 100644
index 0000000..47e0266
--- /dev/null
+++ b/docs/api/fav.md
@@ -0,0 +1,138 @@
+---
+title: QQ收藏 接口
+icon: feather-alt
+---
+
+::: warning 注意
+这里的API处于实验性阶段，不会进行大量维护和更新，由于过于简单，如果需要某些功能可以自行PR！
+:::
+
+
+## 获取收藏列表
+
+获取收藏列表
+
+### API端点
+
+`/fav/get_item_list` (HTTP)
+
+`fav.get_item_list` (WebSocket)
+
+## 参数
+
+| 字段   | 类型    | 必须 | 说明                 | 默认值 |
+| ------ | ------- | ---- | -------------------- | ------ |
+| page_size  | int32 | 是   | 获取的数量             |        |
+| category  | int32 | 是   | 分类             |        |
+| start_pos  | int32 | 是   | 开始的位置             |        |
+
+### 响应
+
+```json 
+{
+  "status": "ok",
+  "retcode": 0,
+  "data": {
+    "items": [
+      {
+        "id": "1-1-9dec6664-dcb7-4b46-986f-xxxxxx",
+        "author_type": 2,
+        "author": 2806922524,
+        "author_name": "2806922524",
+        "group_name": "ˢʰᵃᵐʳᵒᶜᵏ",
+        "group_id": 333425833,
+        "client_version": "8.9.12820",
+        "time": 1703004793000
+      }
+    ]
+  },
+  "echo": ""
+}
+```
+
+## 获取指定收藏的内容
+
+获取收藏内容
+
+### API端点
+
+`/fav/get_item_content` (HTTP)
+
+`fav.get_item_content` (WebSocket)
+
+## 参数
+
+| 字段   | 类型    | 必须 | 说明                 | 默认值 |
+| ------ | ------- | ---- | -------------------- | ------ |
+| id  | string | 是   | id             |        |
+
+### 响应
+
+```json 
+{
+  "status": "ok",
+  "retcode": 0,
+  "data": {
+    "content": "在想可不可以在手机上跑bot（）"
+  },
+  "echo": ""
+}
+```
+
+## 添加文本收藏
+
+添加一段文字到QQ收藏
+
+### API端点
+
+`/fav/add_text_msg` (HTTP)
+
+`fav.add_text_msg` (WebSocket)
+
+## 参数
+
+| 字段   | 类型    | 必须 | 说明                 | 默认值 |
+| ------ | ------- | ---- | -------------------- | ------ |
+| content  | string | 是   | 内容             |        |
+
+### 响应
+
+```json 
+{
+  "status": "ok",
+  "retcode": 0,
+  "data": {
+    "id": "xxxxxxxx"
+  },
+  "echo": ""
+}
+```
+
+## 添加图片收藏
+
+添加一个图片到QQ收藏
+
+### API端点
+
+`/fav/add_image_msg` (HTTP)
+
+`fav.add_image_msg` (WebSocket)
+
+## 参数
+
+| 字段   | 类型    | 必须 | 说明                 | 默认值 |
+| ------ | ------- | ---- | -------------------- | ------ |
+| file  | string | 是   | 图片base64或者绝对路径或者URL             |        |
+
+### 响应
+
+```json 
+{
+  "status": "ok",
+  "retcode": 0,
+  "data": {
+    "id": "xxxxxxxx"
+  },
+  "echo": ""
+}
+```
\ No newline at end of file