|
@@ -1,6 +1,6 @@
|
|
|
# dmp-file接口
|
|
|
|
|
|
-## 使用引导
|
|
|
+## 后端使用引导
|
|
|
|
|
|
### 1.引入jar坐标(Maven方式)
|
|
|
|
|
@@ -39,6 +39,7 @@
|
|
|
```
|
|
|
|
|
|
|
|
|
+
|
|
|
## 文件管理接口
|
|
|
|
|
|
### 41001 保存文件信息
|
|
@@ -478,5 +479,293 @@ POST请求
|
|
|
|
|
|
|
|
|
|
|
|
+### 41006 获得断点上传文件的分片信息
|
|
|
+
|
|
|
+#### 接口
|
|
|
+
|
|
|
+`http://localhost:8831/dmp-file/file/initChunkUpload?groupCode=YL&userId=0`
|
|
|
+
|
|
|
+#### 请求方式
|
|
|
+
|
|
|
+POST请求
|
|
|
+
|
|
|
+#### RequestHeader
|
|
|
+
|
|
|
+| key | value |
|
|
|
+| ------------ | ---------------- |
|
|
|
+| Content-Type | application/json |
|
|
|
+
|
|
|
+#### RequestParam(URL中的Path参数)
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| --------- | -------- | -------- |
|
|
|
+| userId | 是 | 用户id |
|
|
|
+| groupCode | 是 | 集团编码 |
|
|
|
+| projectId | 否 | 项目id |
|
|
|
+| appId | 否 | 应用id |
|
|
|
+
|
|
|
+#### 参数例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "fileMd5":"***",
|
|
|
+ "fileName":"***",
|
|
|
+ "chunkCount":3
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| ---------- | -------- | ------------------------------------------------------------ |
|
|
|
+| fileMd5 | 是 | 文件内容的MD5值 |
|
|
|
+| fileName | 是 | 文件名称 |
|
|
|
+| chunkCount | 是 | 文件的分片数,文件切片的算子必须大于5M,且每个分片的大小不能小于5M |
|
|
|
+
|
|
|
+#### 成功例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result": "success",
|
|
|
+ "data": {
|
|
|
+ "id": "123456",
|
|
|
+ "uploadCode": 200,
|
|
|
+ "content": [
|
|
|
+ {
|
|
|
+ "partNumber":1,
|
|
|
+ "uploadUrl":"http://..."
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 子字段 | 是否必有 | 字段说明 |
|
|
|
+| ---------- | ---------- | -------- | ------------------------------------------------------------ |
|
|
|
+| id | | 否 | uploadCode为200会有值. |
|
|
|
+| uploadCode | | 是 | 文件上传标识<br/>200-秒传<br/>202-断点续传且文件分片均已上传<br/>203-断点续传 |
|
|
|
+| content | | 否 | uploadCode为203会有值 |
|
|
|
+| | partNumber | 是 | 分片序号 |
|
|
|
+| | uploadUrl | 是 | 文件上传URL<br/>使用该url直接上传文件到文件服务器 |
|
|
|
+
|
|
|
+#### 接口修改记录
|
|
|
+
|
|
|
+| 操作时间 | 操作 | 操作内容 |
|
|
|
+| ---------------------- | ---- | -------- |
|
|
|
+| 2021年10月23日14:52:11 | 新增 | 新增接口 |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+### 41007 合并上传的断点续传文件
|
|
|
+
|
|
|
+#### 接口
|
|
|
+
|
|
|
+`http://localhost:8831/dmp-file/file/composeFile?groupCode=YL&userId=0`
|
|
|
+
|
|
|
+#### 请求方式
|
|
|
+
|
|
|
+POST请求
|
|
|
+
|
|
|
+#### RequestHeader
|
|
|
+
|
|
|
+| key | value |
|
|
|
+| ------------ | ---------------- |
|
|
|
+| Content-Type | application/json |
|
|
|
+
|
|
|
+#### RequestParam(URL中的Path参数)
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| --------- | -------- | -------- |
|
|
|
+| userId | 是 | 用户id |
|
|
|
+| groupCode | 是 | 集团编码 |
|
|
|
+| projectId | 否 | 项目id |
|
|
|
+| appId | 否 | 应用id |
|
|
|
+
|
|
|
+#### 参数例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "fileMd5":"***",
|
|
|
+ "fileName":"***",
|
|
|
+ "fileBucket":"ADM"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| ---------- | -------- | ------------------------------------------------------------ |
|
|
|
+| fileMd5 | 是 | 文件内容的MD5值 |
|
|
|
+| fileName | 是 | 文件名称 |
|
|
|
+| fileBucket | 是 | 存储空间名称<br>允许字符:小写字母、连字符、数字<br>长度为3至63<br>开头和结尾必须是字母或数字 |
|
|
|
+
|
|
|
+#### 成功例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result": "success",
|
|
|
+ "data": {
|
|
|
+ "id": "123456"
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必有 | 字段说明 |
|
|
|
+| ---- | -------- | -------- |
|
|
|
+| id | 是 | 文件id |
|
|
|
+
|
|
|
+#### 接口修改记录
|
|
|
+
|
|
|
+| 操作时间 | 操作 | 操作内容 |
|
|
|
+| ---------------------- | ---- | -------- |
|
|
|
+| 2021年10月23日15:04:14 | 新增 | 新增接口 |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+### 41008 获得文件上传信息
|
|
|
+
|
|
|
+#### 接口
|
|
|
+
|
|
|
+`http://localhost:8831/dmp-file/file/initSingleUpload?groupCode=YL&userId=0`
|
|
|
+
|
|
|
+#### 请求方式
|
|
|
+
|
|
|
+POST请求
|
|
|
+
|
|
|
+#### RequestHeader
|
|
|
+
|
|
|
+| key | value |
|
|
|
+| ------------ | ---------------- |
|
|
|
+| Content-Type | application/json |
|
|
|
+
|
|
|
+#### RequestParam(URL中的Path参数)
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| --------- | -------- | -------- |
|
|
|
+| userId | 是 | 用户id |
|
|
|
+| groupCode | 是 | 集团编码 |
|
|
|
+| projectId | 否 | 项目id |
|
|
|
+| appId | 否 | 应用id |
|
|
|
+
|
|
|
+#### 参数例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "fileMd5":"***",
|
|
|
+ "fileName":"***",
|
|
|
+ "fileBucket":"adm",
|
|
|
+ "fileSize":10240
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| ---------- | -------- | ------------------------------------------------------------ |
|
|
|
+| fileMd5 | 是 | 文件内容的MD5值 |
|
|
|
+| fileName | 是 | 文件名称 |
|
|
|
+| fileBucket | 是 | 存储空间名称<br/>允许字符:小写字母、连字符、数字<br/>长度为3至63<br/>开头和结尾必须是字母或数字 |
|
|
|
+| fileSize | 是 | 文件内容字节长度 |
|
|
|
+
|
|
|
+#### 成功例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result": "success",
|
|
|
+ "data": {
|
|
|
+ "id": "123456",
|
|
|
+ "uploadCode": 200,
|
|
|
+ "content": [
|
|
|
+ {
|
|
|
+ "partNumber":1,
|
|
|
+ "uploadUrl":"http://..."
|
|
|
+ }
|
|
|
+ ]
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 子字段 | 是否必有 | 字段说明 |
|
|
|
+| ---------- | ---------- | -------- | ------------------------------------------------- |
|
|
|
+| id | | 是 | 文件id |
|
|
|
+| uploadCode | | 是 | 文件上传标识<br/>200-秒传<br/>201-单个文件上传 |
|
|
|
+| content | | 否 | uploadCode为201会有值 |
|
|
|
+| | partNumber | 是 | 分片序号 |
|
|
|
+| | uploadUrl | 是 | 文件上传URL<br/>使用该url直接上传文件到文件服务器 |
|
|
|
+
|
|
|
+#### 接口修改记录
|
|
|
+
|
|
|
+| 操作时间 | 操作 | 操作内容 |
|
|
|
+| ---------------------- | ---- | -------- |
|
|
|
+| 2021年10月23日14:52:11 | 新增 | 新增接口 |
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+### 41009 获得文件下载信息
|
|
|
+
|
|
|
+#### 接口
|
|
|
+
|
|
|
+`http://localhost:8831/dmp-file/file/initFileDownload?groupCode=YL&userId=0`
|
|
|
+
|
|
|
+#### 请求方式
|
|
|
+
|
|
|
+POST请求
|
|
|
+
|
|
|
+#### RequestHeader
|
|
|
+
|
|
|
+| key | value |
|
|
|
+| ------------ | ---------------- |
|
|
|
+| Content-Type | application/json |
|
|
|
+
|
|
|
+#### RequestParam(URL中的Path参数)
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| --------- | -------- | -------- |
|
|
|
+| userId | 是 | 用户id |
|
|
|
+| groupCode | 是 | 集团编码 |
|
|
|
+| projectId | 否 | 项目id |
|
|
|
+| appId | 否 | 应用id |
|
|
|
+
|
|
|
+#### 参数例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "fileId":"***"
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必须 | 字段说明 |
|
|
|
+| ------ | -------- | -------- |
|
|
|
+| fileId | 是 | 文件id |
|
|
|
+
|
|
|
+#### 成功例子
|
|
|
+
|
|
|
+```
|
|
|
+{
|
|
|
+ "result": "success",
|
|
|
+ "data": {
|
|
|
+ "id": "1451771582172012545",
|
|
|
+ "groupCode": "YL",
|
|
|
+ "fileName": "572573a50fed51c18a3decbe46c1f599.jpeg",
|
|
|
+ "fileType": "0",
|
|
|
+ "fileBucket": "adm",
|
|
|
+ "fileSize": 841926,
|
|
|
+ "fileMd5": "ebda7668886ceec6fc11997844d75ff3",
|
|
|
+ "businessId": "1451771580297158658",
|
|
|
+ "fileDownloadUrl": "http://192.168.100.102:31335/adm/YL/20211023/572573a50fed51c18a3decbe46c1f599.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=persagy%2F20211023%2FGM%2B8%2Fs3%2Faws4_request&X-Amz-Date=20211023T071455Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=20db5a336991ba4a706e67e6b3154e897981f55481981d73805181100574f1f9"
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+| 字段 | 是否必有 | 字段说明 |
|
|
|
+| --------------- | -------- | ------------------------ |
|
|
|
+| id | 是 | 文件id |
|
|
|
+| groupCode | 是 | 集团编码 |
|
|
|
+| fileName | 是 | 文件名称 |
|
|
|
+| fileType | 是 | 文件类型,0-文件,1-文件夹 |
|
|
|
+| fileBucket | 是 | 存储空间名称 |
|
|
|
+| fileSize | 否 | 文件长度,单位为字节 |
|
|
|
+| fileMd5 | 是 | 文件内容的MD5值 |
|
|
|
+| businessId | 否 | 文件对应的业务id |
|
|
|
+| fileDownloadUrl | 是 | 文件下载地址 |
|
|
|
+
|
|
|
+#### 接口修改记录
|
|
|
|
|
|
+| 操作时间 | 操作 | 操作内容 |
|
|
|
+| ---------------------- | ---- | -------- |
|
|
|
+| 2021年10月23日15:18:11 | 新增 | 新增接口 |
|
|
|
|