瀏覽代碼

add first doc

liu599 5 年之前
父節點
當前提交
4e0cd9fea2
共有 1 個文件被更改,包括 46 次插入2 次删除
  1. 46 2
      README.md

+ 46 - 2
README.md

@@ -1,5 +1,10 @@
 ## 文档
 
+### 基本约定
+
+- API主地址: https://mltd.ecs32.top
+- 文件物理地址: https://file.ecs32.top/data/{relative_path}/{src}
+
 ### 数据结构
 
 - File 文件
@@ -36,5 +41,44 @@
 
 ### 接口文档
 
-- 文件CURD(暂时有可用的系统)、标签CURD(登录授权暂时有可用的系统)
-- 需要开发的是标签CURD, 标签文件映射表修改
+- 用户创建和删除(准备手动..因为没几个人需要)
+- 用户登录授权(有系统)
+- 文件CURD(暂时有可用的系统, 需要修改)
+	- /filelist POST 获取某一类型的文件列表
+        - 参数 文件类型:
+            - fileType:mp3
+        - 返回值为数组
+            - FileNo: 23
+            - createdAt: 1543509878
+            - fileId: "5c001776421aa92da962fa2c"
+            - fileName: "IMG_3252.PNG"
+            - filetype: "png"
+            - hashId: "d9f25b4f5dfdf1d9e23e85f2dc4e368e"
+            - modifiedAt: 1543509878
+            - relativePath: "/"
+            - src: "/5c001776421aa92da962fa2c__IMG_3252.PNG"
+	- /filelist GET 获取所有文件列表 返回值为数组
+        - "FileNo": 1,
+        - "fileName": "DkTFZgzUwAEzg1j.jpg",
+        - "fileId": "5bddd247421aa966cb625f42",
+        - "hashId": "58ea7605cf9598bd562bb47a8b5c716a",
+        - "createdAt": 1541263943,
+        - "modifiedAt": 1541263943,
+        - "relativePath": "/",
+        - "src": "/5bddd247421aa966cb625f42__DkTFZgzUwAEzg1j.jpg",
+        - "filetype": "jpg"
+	- /nekofile/:fileid/*size GET 通过文件ID获取文件本身
+		- 参数: fileid(路径中)
+		- 返回值 文件本身
+	- /upload POST
+        - 参数: 
+            - name
+            - relativePath
+            - base64文件
+        - 返回值
+            - router: '文件相对路径列表'
+            - file_md5_list: 文件md5值列表
+            - psy_path_list: 文件物理地址列表
+            - message: 上传成功的信息
+- 标签CURD(未开发)
+- 标签文件映射表修改(未开发)