Bläddra i källkod

更新 'api.md'

pudilang 4 år sedan
förälder
incheckning
259ccc2ac6
1 ändrade filer med 117 tillägg och 4 borttagningar
  1. 117 4
      api.md

+ 117 - 4
api.md

@@ -1,7 +1,120 @@
-*  登录接口
+### 1.登录
+  ##### 接口地址:  POST http://sintmo.com:8082/api/login
+  ##### 请求参数 - json
+    {
+        "username": "lsj",
+        "password": "lsj999"
+    }
+  ##### 响应参数
+    token 传入其它接口Authorization请求头
+    如:Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+    {
+        "success": true,
+        "code": 200,
+        "msg": "",
+        "data": {
+            "token": "mRXoggDVXKNwNUOonP66Dp"
+        }
+    }
 
+### 2.Index
+  ##### 接口地址: GET http://sintmo.com:8082/api/v
+  ##### 请求头
+    Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+  ##### 请求参数 - url
+    UrlParam
+        i : 从 1 开始到接口返回的total
+    例: http://sintmo.com:8082/api/v?i=1
+  ##### 响应参数
+    {
+        "success": true,
+        "code": 200,
+        "msg": "",
+        "data": {
+            "total": 3, // 总视频数量
+            "video": {
+                "vid": "mRXoggDVXKNwNUOonP65yX", // vid,用于获取视频流和删除视频
+                "size": 1861311, // 大小
+                "name": "thread__16953269_20200526163129_48212.mp4"
+            }
+        }
+    }
 
-```
-url: http://sintmo.com:8082/api/login
+### 3.获取视频流
+  ##### 接口地址: GET http://sintmo.com:8082/api/v/{vid}
+  ##### 请求头
+    Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+  ##### 请求参数 - url
+    vid: index接口返回的vid
+    例: http://sintmo.com:8082/api/v/mRXoggDVXKNwNUOonP65yX
+  ##### 响应参数
+    返回文件流
 
-```
+### 4.删除视频
+  ##### 接口地址: DELETE http://sintmo.com:8082/api/v/{vid}
+  ##### 请求头
+    Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+  ##### 请求参数 - url
+    vid: index接口返回的vid
+    例: http://sintmo.com:8082/api/v/mRXoggDVXKNwNUOonP65yX
+  ##### 响应参数 
+    {
+        "success": true,
+        "code": 200,
+        "msg": "",
+        "data": null
+    }
+    
+### 5.上传视频
+  ##### 接口地址: POST http://sintmo.com:8082/api/v/upload
+  ##### 请求头
+    Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+  ##### 请求参数 - form-data
+    form-data
+        file : 文件对象
+  ##### 响应参数 
+    {
+        "success": true,
+        "code": 200,
+        "msg": "",
+        "data": null
+    }
+    
+### 6.视频列表
+  ##### 接口地址: POST http://sintmo.com:8082/api/v/list
+  ##### 请求头
+    Authorization: Bearer mRXoggDVXKNwNUOonP66Dp
+  ##### 请求参数
+    form-data
+        file : 文件对象
+  ##### 响应参数 
+    {
+        "success": true,
+        "code": 200,
+        "msg": "",
+        "data": {
+            "total": 4,
+            "list": [
+                {
+                    "vid": "mRXoggDVXKNwNUOonP65yX", // vid,用户获取流和删除
+                    "size": 1861311, // 视频大小,字节
+                    "name": "thread__16953269_20200526163129_48212.mp4" // 视频名称
+                },
+                {
+                    "vid": "mRXoggDVXKNwNUOonP663d",
+                    "size": 28325502,
+                    "name": "新疆建设兵团.mp4"
+                },
+                {
+                    "vid": "mRXoggDVXKNwNUOonP668j",
+                    "size": 1659945,
+                    "name": "铁头功.mp4"
+                },
+                {
+                    "vid": "mRXoggDVXKNwNUOonP66Iv",
+                    "size": 862081,
+                    "name": "1606790636587175.mp4"
+                }
+            ]
+        }
+    }