歸併

README.md

@@ -10,16 +10,14 @@ ai 繪圖服務端(快速重構)
 - [ ] /api/models [#模型列表](#模型列表)
 - [ ] /api/images [#圖片列表](#圖片列表)
 
-列表接口-請求方式:
+列表接口-請求方式
-- [ ] GET
-    列表接口篩選規則:(數據過濾)
 Method | URL                            | Info
 -------|--------------------------------|------------------
-    GET    | /api/{name}?user=1234          | 僅取指定用戶的(按用戶ID過濾)
+GET    | /api/{name}?user_id=1234       | 僅取指定用戶的
 GET    | /api/{name}?tag=xxx            | 按標籤分類篩選
 GET    | /api/{name}?public=true        | 僅取公開的
 GET    | /api/{name}?public=false       | 僅取私有的
-- [ ] POST
+POST   | /api/{name}                    | 創建新對象
 
 
 詳情接口:
@@ -30,13 +28,81 @@ ai 繪圖服務端(快速重構)
 - [ ] /api/images/{image_id} [#圖片詳情](#圖片詳情)
 
 詳情接口-請求方式:
-- [ ] PATCH
+Method | URL                            | Info
-- [ ] DELETE
+-------|--------------------------------|------------------
-- [ ] WebSocket
+GET    | /api/{name}/{item_id}          | 獲取對象詳情
+PATCH  | /api/{name}/{item_id}          | 修改對象字段
+DELETE | /api/{name}/{item_id}          | 刪除對象
+WS     | /api/{name}/{item_id}          | Websocket 連接對象
+
 
 * GET查詢以外的操作都必須在headers中攜帶token驗證身份權限
 * GET查詢私有模型也必須登錄, 否則不會被展示
 
+
+對象模型:
+```javascript
+// ListView 列表分頁
+{
+    page: 1,             // 当前页码
+    pageSize: 20,        // 分页数
+    next: true,          // 是否存在下一页
+    list: []             // 列表數據
+}
+
+// Image 圖片對象
+{
+    id: 1234,        // 原图ID
+    width: 512,      // 原图宽度
+    height: 512,     // 原图高度
+    createdAt: '',   // 創建時間
+    updatedAt: '',   // 更新時間
+    user: {          // 来源用户
+        id: 1234,
+        user_name: 'LAST',
+    },
+    article: {       // 来源文章
+        id: 1234,
+        title: 'GAMEX',
+    }
+}
+
+// Model 模型對象
+{
+    id: 'xxxxx',     // 模型ID
+    name: 'xxx',     // 模型名稱
+    createdAt: '',   // 創建時間
+    updatedAt: '',   // 更新時間
+}
+
+// Task 任務對象
+{
+    id: 'xxxxx',     // 任務ID
+    name: 'xxx',     // 任務名稱
+    status: 'xxx',   // 任務狀態(waiting|running|success|error)
+    progress: 100,   // 任務進度(0~100)
+    data: {},        // 任務數據
+    createdAt: '',   // 創建時間
+    updatedAt: '',   // 更新時間
+}
+
+// User 用戶對象
+{
+    id: 'xxxxx',     // 用戶ID
+    name: 'xxx',     // 用戶名稱
+    createdAt: '',   // 創建時間
+    updatedAt: '',   // 更新時間
+}
+
+// Tag 標籤對象
+{
+    id: 'xxxxx',     // 標籤ID
+    name: 'xxx',     // 標籤名稱
+    createdAt: '',   // 創建時間
+    updatedAt: '',   // 更新時間
+}
+```
+
 ---------------------------------------------------------------
 
 ### 圖片列表