From bdaf0461947f1b63b6bed5e1f453597b5a8c232f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=A1=9C=E8=8F=AF?= <huan0016@gmail.com>
Date: Thu, 9 Mar 2023 11:39:51 +0800
Subject: [PATCH] docs

---
 README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 93 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d975c04..fce6704 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,95 @@
 # weight
 
-通用权重模型
\ No newline at end of file
+通用权重模型
+
+
+## 获取图片列表(标准查询)
+GET /api/images
+
+```javascript
+{
+    page: 1,             // 当前页码
+    pageSize: 20,        // 分页数
+    next: true,          // 是否存在下一页
+    list: [
+        {
+            id: 1234,    // 原图ID
+            width: 512,  // 原图宽度
+            height: 512, // 原图高度
+            user: {      // 来源用户
+                id: 1234,
+                name: 'LAST',
+            },
+            article: {   // 来源文章
+                id: 1234,
+                title: 'GAMEX',
+            }
+        }
+    ]
+}
+```
+标准查询(select)
+1. 按照标签查询权重最相近的(tag=tag1)
+2. 按照时间段查询(date=20210203~20220102||20210203+||20210203-)
+3. 按照发表用户查询(user=1234)
+4. 按照精选集查询(choice=1234)
+
+取交集(筛选必须包含所有指定标签的)
+1. 过滤出多个标签的交集(tags=tag1,tag2,tag3)
+
+取并集(筛选任意包含其中一个标签的)
+1. 多个标签同时存在(tags=tag1+,tag2+)
+
+取差集(排除含有指定标签的)
+1. 排除含有指定标签的(tags=tag1-,tag2-)
+
+
+取子集(不提供)
+取补集(不提供)
+
+混写示例: (当混写时交集最优先, 并集优先于差集)
+`GET /api/images?tags=tag1,tag2,tag4+,tag3-`
+
+
+数据排序(sort)
+1. 按照时间正反序(sort=date+||date-)
+
+
+列表分页(page)
+1. 分页大小 pageSize=20
+2. 指定页码 page=1 (当结束时, 返回next字段为false)
+
+
+## 获取标签列表(热门标签)
+GET /api/tags
+```javascript
+{
+    page: 1,
+    pageSize: 20,
+    next: true,
+    list: [
+        {
+            id: 1234,        // 标签ID
+            name: 'tagName', // 标签名
+            count: 2,        // 标签索引的图像数量
+        }
+    ]
+}
+```
+
+## 实时搜索
+WS /api/search
+
+```javascript
+{
+    tags: [
+        {
+            id: 1234,
+            name: 'tagName',
+            count: 2,
+        }
+    ]
+}
+```
+* 选中搜索框时建立WS连接
+* 离开搜索框时应及时断开WS连接