Browse Source

add white user api

huodongdong 6 years ago
parent
commit
4c76866ac6
2 changed files with 64 additions and 0 deletions
  1. 41 0
      api/cms/white_user/user_list.md
  2. 23 0
      api/cms/white_user/user_save.md

+ 41 - 0
api/cms/white_user/user_list.md

@@ -0,0 +1,41 @@
+### GET /white/user/list
+* method: GET
+* version: v1.0
+* describe: 获取白名单用户列表
+
+##### 参数说明
+
+|name |type| null | desc |
+|---- |:---|:---|:----:|
+| code | string | no | 学号 |
+| pageNo | int | yes | 页码 |
+| pageSize | int | yes | 页大小
+
+##### 返回格式说明
+```
+{
+    "code": 200,
+    "success": true,
+    "message": null,
+    "data": {
+        "pageNo": 1,
+        "pageSize": 10,
+        "totalSize": 1,
+        "list": [
+            {
+                "id": "1",
+                "userId": "xxxx",
+                "code": "xxxx",
+                "startTime: xxx,
+                'endTime': xxx,
+                "status": "NORMAL",
+                "gmtCreated": 1513576267000,
+                "gmtModified": 1516103799000,
+            },
+            ...
+        ],
+        "start": 0,
+        "totalNo": 1
+    }
+}
+```

+ 23 - 0
api/cms/white_user/user_save.md

@@ -0,0 +1,23 @@
+### POST /white/user
+* method: POST
+* version: v1.0
+* describe: 创建白名单用户
+
+
+* method: PUT
+* version: v1.0
+* describe: 修改白名单用户
+
+### DELETE /white/user
+* method: DELETE
+* version: v1.0
+* describe: 删除用户
+
+##### 参数说明
+{
+    "id": "1",
+    "userId": 'xxx',
+    "startTime": xxxx,
+    "endTime": xxxx,
+    "status": "NORMAL",
+}