瀏覽代碼

Merge branch 'develop' of http://39.106.8.246:3003/persagy/persagy-dmp-server-doc into develop

# Conflicts:
#	docs/migrate/migrate_api.md
luoguangyi 3 年之前
父節點
當前提交
d20e66a3f7
共有 2 個文件被更改,包括 178 次插入10 次删除
  1. 67 10
      docs/file/file_api.md
  2. 111 0
      docs/migrate/migrate_api.md

+ 67 - 10
docs/file/file_api.md

@@ -28,7 +28,7 @@ uploadFile('http://develop.persagy.com/dmp-file', 'YL', event.target.files[0], f
 
 ```
 
-### 
+ 
 
 ## 后端使用引导
 
@@ -55,17 +55,16 @@ uploadFile('http://develop.persagy.com/dmp-file', 'YL', event.target.files[0], f
   FileStorageHelper.uploadFile(fileInfo, inputStream);
 ```
 
-### 3.配置说明
+### 3.使用如下实例代码进行文件下载
 
 ```
-  # 使用的文件服务器,默认为MinIO。详见FileStorageEnum
-  persagy.common.file.storage=0
-  # MinIO服务地址、账号、密码
-  persagy.common.file.url=http://192.168.25.129:9000/
-  persagy.common.file.accessKey=admin
-  persagy.common.file.secretKey=********
-  # typeHandler扫描
-  mybatis-plus.typeHandlersPackage=com.persagy.**.typehandler
+ // 通过文件id获取文件流,当文件url不存在时会抛出系统资源异常的错误
+ FileStorageHelper.downloadStream(fileId);
+ 或者
+ // 1.根据文件id获取文件下载地址
+ FileInfo info = FileStorageHelper.downloadUrl(fileId);
+ // 2.通过http请求获取文件流
+ IoUtil.toStream(HttpUtil.downloadBytes(info.getFileDownloadUrl()));
 ```
 
 
@@ -799,3 +798,61 @@ POST请求
 | ---------------------- | ---- | -------- |
 | 2021年10月23日15:18:11 | 新增 | 新增接口 |
 
+### 41010 根据文件id批量获取文件下载信息
+
+#### 接口
+
+`http://localhost:8831/dmp-file/file/queryFetchUrlsByFileIds?groupCode=XG&userId=0`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 否       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+  "fileIds":["***"]
+}
+```
+
+| 字段   | 是否必须 | 字段说明 |
+| ------ | -------- | -------- |
+| fileId | 是       | 文件id   |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": {
+        "文件id": "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,调用时使用的是PUT请求"
+    }
+}
+```
+
+| 字段   | 是否必有 | 字段说明                       |
+| ------ | -------- | ------------------------------ |
+| 文件id | 是       | 传参的文件id,值为文件下载地址 |
+
+#### 接口修改记录
+
+| 操作时间               | 操作 | 操作内容 |
+| ---------------------- | ---- | -------- |
+| 2021年12月31日15:24:46 | 新增 | 新增接口 |
+

+ 111 - 0
docs/migrate/migrate_api.md

@@ -0,0 +1,111 @@
+# 数据迁移设计
+访问adm-middleware服务
+字典数据只针对集团、项目级数据,不包含通用定义数据。
+
+## 迁移日志数据结构
+
+### 1. 表名(dt_sync_data)
+
+| 字段          | 字段说明       | 数据类型     | 备注                 |
+| ------------- | -------------- | ------------ | -------------------- |
+| id            | 主键           | varchar(100) | 32位UUID             |
+| table_name    | 同步表名称     | varchar(32)  |					   |
+| target_id     | 同步数据id     | varchar(100) | 对象id/关系id/类型id/信息点id|
+| object_type   | 对象类型       | varchar(200) | 			           |
+| type          | 操作类型       | varchar(200) |                      |
+| project_id    | 项目id         | varchar(200) |					   |
+| sign		    | 标记           | int          |                      |
+| ops           | 操作符         | varchar(200) |                      |
+| ops_name      | 操作符名称     | varchar(200) |                      |
+| from_id       | 主id           | varchar(100) |                      |
+| to_id         | 从id           | varchar(100) |                      |
+| error         | 错误内容       | longtext     |                      |
+| class_code    | 类型           | varchar(100) |                      |
+| local_name    | 本地名称       | varchar(200) |                      |
+| local_id      | 本地编码       | varchar(200) |                      |
+| name          | 名称           | varchar(200) |                      |
+| code          | code			 |varchar(200)  |                      |
+| creator     |           创建人           | varchar(32)  |                       |
+| creation_time  |          创建时间          |   char(14)   | 格式为yyyyMMddHHmmss  |
+| modifier    |         最后修改人         | varchar(32)  |                       |
+| modified_time  |        最后修改时间        |   char(14)   | 格式为yyyyMMddHHmmss  |
+| valid      |          合法标识          |  tinyint(4)  |     0-无效,1-有效     |
+| ts       |           乐观锁           |  timestamp   |                       |
+
+### 2 接口
+
+#### m20001 待迁移数据信息获取,返回excel
+##### 接口:
+`http://develop.ysbdtp.com/datacenter/data/migration/excel`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+| projectId    | Pj9909990004(项目id)|
+| groupCode    | JDCS(项目集团编码)|
+
+#### RequestBody
+```
+{
+    //待迁移项目可访问的地址(域名和IP均可),此地址用于调用待迁移项目的中台服务接口。
+    "targetUrl":"http://develop.persagy.com" 
+}
+```
+
+#### m20002 迁移数据 覆盖项目现场数据
+##### 接口:
+`http://develop.ysbdtp.com/datacenter/data/migration/start`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+| projectId    | Pj9909990004(项目id)|
+| groupCode    | JDCS(项目集团编码)|
+
+#### RequestBody
+```
+{
+    //待迁移项目可访问的地址(域名和IP均可),此地址用于调用待迁移项目的中台服务接口。
+    "targetUrl":"http://develop.persagy.com"
+}
+```
+
+
+#### m20003 迁移数据 日志查看
+##### 接口:
+`http://develop.ysbdtp.com/datacenter/data/migration/log`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+| projectId    | Pj9909990004(项目id)|
+| groupCode    | JDCS(项目集团编码)|
+
+#### RequestBody
+```
+{
+"order": "lastUpdate asc, objId asc",
+"pageNumber": 1,
+"pageSize": 15,
+"filters": "projectId='Pj9909990004';sign=2;type='create';objectType='building'"
+}
+```
+