Browse Source

新增版本管理的接口文档

lijie 3 years ago
parent
commit
85aeb02d3e
3 changed files with 344 additions and 0 deletions
  1. 52 0
      docs/version/data_structure_description.md
  2. 5 0
      docs/version/index.md
  3. 287 0
      docs/version/version_api.md

+ 52 - 0
docs/version/data_structure_description.md

@@ -0,0 +1,52 @@
+# 物理世界
+
+## 数据结构
+
+### 1.对象实例表(dt_object)
+
+| 字段          | 字段说明       | 数据类型    | 备注                                         |
+| ------------- | -------------- | ----------- | -------------------------------------------- |
+| id            | 主键           | varchar(40) | 32位UUID                                     |
+| version       | 版本编号       | varchar(40) | 全局唯一                                     |
+| state         | 版本状态       | varchar(2)  | 0-已取消,1-待确认,2-待发布,3-发布中,4-已完成 |
+| last_flag     | 最新标识       | tinyint(4)  | 0-历史,1-最新                                |
+| last_version  | 上一版本号     | varchar(40) |                                              |
+| show_order    | 显示顺序       | int(11)     |                                              |
+| confirm_user  | 确认人         | varchar(40) | 集团编码                                     |
+| confirm_time  | 确认时间       | char(14)    | 格式为yyyyMMddHHmmss                         |
+| publish_user  | 发布人         | int(11)     | 1单个对象,2对象组                            |
+| publish_time  | 发布时间       | char(14)    | 格式为yyyyMMddHHmmss                         |
+| finish_time   | 完成时间       | char(14)    | 格式为yyyyMMddHHmmss                         |
+| creator       | 创建人账号id   | varchar(32) |                                              |
+| creation_time | 创建时间       | char(14)    | 格式为yyyyMMddHHmmss                         |
+| modified_time | 最后更新时间   | char(14)    | 格式为yyyyMMddHHmmss                         |
+| modifier      | 最后更新账号id | varchar(32) |                                              |
+| valid         | 合法标识       | tinyint(4)  | 0-无效,1-有效                                |
+| ts            | 乐观锁         | timestamp   |                                              |
+
+## DDL语句
+
+### 版本定义表
+
+```sql
+CREATE TABLE IF NOT EXISTS `dt_define_version` (
+  `id` varchar(40) NOT NULL COMMENT '主键',
+  `version` varchar(40) DEFAULT NULL COMMENT '版本编号,全局唯一',
+  `state` varchar(2) DEFAULT NULL COMMENT '版本状态,0-已取消,1-待确认,2-待发布,3-发布中,4-已完成',
+  `last_flag` tinyint(4) DEFAULT NULL COMMENT '最新标识,0-非最新,1-最新',
+  `last_version` varchar(40) DEFAULT NULL COMMENT '上一版本号',
+  `show_order` int(11) DEFAULT NULL COMMENT '显示顺序',
+  `confirm_user` varchar(32) DEFAULT NULL COMMENT '确认人',
+  `confirm_time` char(14) DEFAULT NULL COMMENT '确认时间,格式为yyyyMMddHHmmss',
+  `publish_user` varchar(32) DEFAULT NULL COMMENT '发布人',
+  `publish_time` char(14) DEFAULT NULL COMMENT '发布时间,格式为yyyyMMddHHmmss',
+  `finish_time` char(14) DEFAULT NULL COMMENT '完成时间,格式为yyyyMMddHHmmss',
+  `creator` varchar(32) DEFAULT NULL COMMENT '创建人',
+  `creation_time` char(14) DEFAULT NULL COMMENT '创建时间,格式为yyyyMMddHHmmss',
+  `modifier` varchar(32) DEFAULT NULL COMMENT '最后更新人',
+  `modified_time` char(14) DEFAULT NULL COMMENT '最后更新时间,格式为yyyyMMddHHmmss',
+  `valid` tinyint(4) DEFAULT NULL COMMENT '合法标识,0-无效,1-有效',
+  `ts` timestamp NULL DEFAULT NULL COMMENT '乐观锁',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='版本定义表';
+```

+ 5 - 0
docs/version/index.md

@@ -0,0 +1,5 @@
+# 版本管理
+
+## [接口文档](/version/version_api.md)
+
+## [数据结构设计](/version/data_structure_description.md)

+ 287 - 0
docs/version/version_api.md

@@ -0,0 +1,287 @@
+# dmp-rwd-version接口
+
+## 版本管理接口
+
+### 31001 创建版本信息
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd-version/rwdedit/version/create`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 否       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+  "version": "PG",
+  "state": "major",
+  "lastFlag": "专业",
+  "lastVersion": "Testing",
+  "showOrder":12,
+  "confirmUser":"**",
+  "confirmTime":"20210813000000",
+  "publishUser":"***",
+  "publishTime":"20210813000000",
+  "finishTime":"20210813000000"
+}
+```
+
+| 字段        | 是否必须 | 字段说明                                              |
+| ----------- | -------- | ----------------------------------------------------- |
+| version     | 是       | 版本号,全局唯一                                       |
+| state       | 否       | 版本状态,0-已取消,1-待确认,2-待发布,3-发布中,4-已完成 |
+| lastFlag    | 否       | 最新标识                                              |
+| lastVersion | 否       | 上一版本号                                            |
+| showOrder   | 否       | 显示顺序                                              |
+| confirmUser | 否       | 确认人                                                |
+| confirmTime | 否       | 确认时间                                              |
+| publishUser | 否       | 发布人                                                |
+| publishTime | 否       | 发布时间                                              |
+| finishTime  | 否       | 完成时间                                              |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": {
+      "id": "dev_1",
+      "version": "PG",
+      "state": "major",
+      "lastFlag": "专业",
+      "lastVersion": "Testing",
+      "showOrder":12,
+      "confirmUser":"**",
+      "confirmTime":"***",
+      "publishUser":"***",
+      "publishTime":"***",
+      "finishTime":"***",
+      "creationTime": "20210813000000",
+      "creator": "wdl",
+      "modifiedTime": "20210813000000",
+      "modifier": "wdl",
+      "valid": 1
+    },
+    "count": 26
+}
+```
+
+| 字段         | 是否必有 | 字段说明                                              |
+| ------------ | -------- | ----------------------------------------------------- |
+| id           | 是       | 32位UUID                                              |
+| version      | 是       | 版本号,全局唯一                                       |
+| state        | 是       | 版本状态,0-已取消,1-待确认,2-待发布,3-发布中,4-已完成 |
+| lastFlag     | 是       | 最新标识                                              |
+| lastVersion  | 是       | 上一版本号                                            |
+| showOrder    | 是       | 显示顺序                                              |
+| confirmUser  | 否       | 确认人                                                |
+| confirmTime  | 否       | 确认时间                                              |
+| publishUser  | 否       | 发布人                                                |
+| publishTime  | 否       | 发布时间                                              |
+| finishTime   | 否       | 完成时间                                              |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss                         |
+| creator      | 否       | 创建人账号id                                          |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss                     |
+| modifier     | 否       | 最后更新账号id                                        |
+| valid        | 否       | 有效状态,0-无效,1-有效                                |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月17日09:45:09 | 新增 | 新增接口 |
+
+
+
+### 31002 更新版本信息
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd-version/rwdedit/version/update`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 否       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+{
+    "id": "dev_1",
+    "version": "PG",
+    "state": "major",
+    "lastFlag": "专业",
+    "lastVersion": "Testing",
+    "showOrder":12,
+    "confirmUser":"**",
+    "confirmTime":"***",
+    "publishUser":"***",
+    "publishTime":"***",
+    "finishTime":"***",
+    "creationTime": "20210813000000",
+    "creator": "wdl",
+    "modifiedTime": "20210813000000",
+    "modifier": "wdl",
+    "valid": 1
+}
+```
+
+| 字段         | 是否必须 | 字段说明                                              |
+| ------------ | -------- | ----------------------------------------------------- |
+| id           | 是       | 32位UUID                                              |
+| version      | 是       | 版本号,全局唯一                                       |
+| state        | 是       | 版本状态,0-已取消,1-待确认,2-待发布,3-发布中,4-已完成 |
+| lastFlag     | 是       | 最新标识                                              |
+| lastVersion  | 是       | 上一版本号                                            |
+| showOrder    | 是       | 显示顺序                                              |
+| confirmUser  | 否       | 确认人                                                |
+| confirmTime  | 否       | 确认时间                                              |
+| publishUser  | 否       | 发布人                                                |
+| publishTime  | 否       | 发布时间                                              |
+| finishTime   | 否       | 完成时间                                              |
+| creationTime | 是       | 创建时间,格式为yyyyMMddHHmmss                         |
+| creator      | 是       | 创建人账号id                                          |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss                     |
+| modifier     | 否       | 最后更新账号id                                        |
+| valid        | 是       | 有效状态,0-无效,1-有效                                |
+
+#### 成功例子
+
+```
+{
+    "result": "success",
+    "data": {
+      "id": "dev_1",
+      "version": "PG",
+      "state": "major",
+      "lastFlag": "专业",
+      "lastVersion": "Testing",
+      "showOrder":12,
+      "confirmUser":"**",
+      "confirmTime":"***",
+      "publishUser":"***",
+      "publishTime":"***",
+      "finishTime":"***",
+      "creationTime": "20210813000000",
+      "creator": "wdl",
+      "modifiedTime": "20210813000000",
+      "modifier": "wdl",
+      "valid": 1
+    },
+    "count": 26
+}
+```
+
+| 字段         | 是否必有 | 字段说明                                              |
+| ------------ | -------- | ----------------------------------------------------- |
+| id           | 是       | 32位UUID                                              |
+| version      | 是       | 版本号,全局唯一                                       |
+| state        | 是       | 版本状态,0-已取消,1-待确认,2-待发布,3-发布中,4-已完成 |
+| lastFlag     | 是       | 最新标识,0-非最新,1-最新                              |
+| lastVersion  | 是       | 上一版本号                                            |
+| showOrder    | 是       | 显示顺序                                              |
+| confirmUser  | 否       | 确认人                                                |
+| confirmTime  | 否       | 确认时间                                              |
+| publishUser  | 否       | 发布人                                                |
+| publishTime  | 否       | 发布时间                                              |
+| finishTime   | 否       | 完成时间                                              |
+| creationTime | 否       | 创建时间,格式为yyyyMMddHHmmss                         |
+| creator      | 否       | 创建人账号id                                          |
+| modifiedTime | 否       | 最后更新时间,格式为yyyyMMddHHmmss                     |
+| modifier     | 否       | 最后更新账号id                                        |
+| valid        | 否       | 有效状态,0-无效,1-有效                                |
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月17日09:45:09 | 新增 | 新增接口 |
+
+
+
+### 31003 删除版本信息
+
+#### 接口
+
+`http://localhost:8831/dmp-rwd-version/rwdedit/version/delete`
+
+#### 请求方式
+
+POST请求
+
+#### RequestHeader
+
+| key          | value            |
+| ------------ | ---------------- |
+| Content-Type | application/json |
+
+#### RequestParam(URL中的Path参数)
+
+| 字段      | 是否必须 | 字段说明 |
+| --------- | -------- | -------- |
+| userId    | 是       | 用户id   |
+| groupCode | 否       | 集团编码 |
+| projectId | 否       | 项目id   |
+| appId     | 否       | 应用id   |
+
+#### 参数例子
+
+```
+"***"
+```
+
+| 字段 | 是否必须 | 字段说明 |
+| ---- | -------- | -------- |
+| id   | 是       | 32位UUID |
+
+#### 成功例子
+
+```
+{
+    "result": "success"
+}
+```
+
+#### 接口修改记录
+
+| 操作时间              | 操作 | 操作内容 |
+| --------------------- | ---- | -------- |
+| 2021年8月17日09:50:14 | 新增 | 新增接口 |
+
+
+
+
+