Ver código fonte

新增人员组织权限与数据字典文档

wudla 4 anos atrás
pai
commit
151b6d340c

+ 13 - 13
docs/.vuepress/config.js

@@ -6,8 +6,8 @@ module.exports = {
 
         nav: [{ text: '主页', link: '/' },
             { text: '物理世界', link: '/rwd/' },
-            { text: '人员组织权限', link: '/org/' }
-            // { text: '数据字典', link: '/dic/'}
+            { text: '人员组织权限', link: '/org/' },
+            { text: '数据字典', link: '/dic/'}
             ],
 
         sidebarDepth: 1,
@@ -24,17 +24,17 @@ module.exports = {
                     ]
                 }
             ],
-            // '/dic': [
-            //     {
-            //         title: '数据字典',
-            //         collapsable: false,
-            //         children: [
-            //             {title: '建表语句', path: '/dic/dic_ddl_sql'},
-            //             {title: '接口文档', path: '/dic/dic_api'},
-            //             {title: '数据结构设计', path: '/dic/dic_design'}
-            //         ]
-            //     }
-            // ],
+            '/dic': [
+                {
+                    title: '数据字典',
+                    collapsable: false,
+                    children: [
+                        {title: '建表语句', path: '/dic/dic_ddl_sql'},
+                        {title: '接口文档', path: '/dic/dic_api'},
+                        {title: '数据结构设计', path: '/dic/dic_design'}
+                    ]
+                }
+            ],
             '/rwd': [
                 {
                     title: '定义数据',

+ 309 - 0
docs/dic/dic_api.md

@@ -0,0 +1,309 @@
+# 数据标准化接口文档
+
+## 模板案例
+
+参考实体类 Example
+
+| 字段 | 类型   |
+| ---- | ------ |
+| id   | int    |
+| name | string |
+| age  | int    |
+
+### 查询(请参考[通用查询](/utils/query.md))
+
+### 新增
+
+请求地址
+
+```text
+/example/create
+```
+
+请求参数
+
+```json
+{
+    "id": "1",
+    "name": "test",
+    "age": "23"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "1"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+
+
+### 更新
+
+请求地址
+
+```json
+POST: /example/update
+```
+
+请求参数
+
+```json
+{
+    "id": "1",
+    "name": "test",
+    "age": "23"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "123456"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+
+
+### 删除
+
+请求地址
+
+```json
+POST: /example/delete
+```
+
+请求参数
+
+```json
+{
+    "id": "1"
+}
+```
+
+返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "1"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+### 
+
+## 系统接口
+
+### (注:condition 为 query,create,update,delete)
+
+### (注:为了读写分离,serviceid还会变动,请不要写死)
+
+### (注:userId、groupCode、projectId必须传值,appId可以为空)
+
+#### 请求方法:POST
+
+#### 字典类型
+
+请求路径:/dt/type/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数
+
+```json
+查询字段:
+{
+  "id": "dev_1",
+  "groupCode": "PG",
+  "type": "major",
+  "name": "专业",
+  "description": "Testing",
+  "status": 1,
+  "createTime": 1602434380000,
+  "createUser": "wdl",
+  "updateTime": 1602705427000,
+  "updateUser": "wdl",
+  "remark": "Testing"
+}
+新增:
+{
+  "type": "major",//非空
+  "name": "专业",//非空
+  "description": "Testing",
+  "remark": "Testing"
+}
+更新:
+{
+  "id": "dev_1",//非空
+  "type": "major",//非空
+  "name": "专业",//非空
+  "description": "Testing",
+  "remark": "Testing"
+}
+删除:
+{
+  "id": ""
+}
+```
+
+#### 字典数据
+
+请求路径:/dt/data/query/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数
+
+```json
+查询字段:
+{
+  "id": "1",
+  "dictTypeId": "1",
+  "parentId": "1",
+  "type": "sex",
+  "code": "A",
+  "label": "man",
+  "status": 0,
+  "createTime": 1602429367000,
+  "createUser": "test",
+  "updateTime": 1602710467000,
+  "updateUser": "test",
+  "remark": "测试数据"
+}
+新增:
+{
+  "dictTypeId": "1",//非空
+  "parentId": "1",
+  "type": "sex",//非空
+  "code": "A",//非空
+  "label": "man",//非空
+  "remark": "测试数据"
+}
+更新:
+{
+  "id": "1",//非空
+  "dictTypeId": "1",//非空
+  "parentId": "1",
+  "type": "sex",//非空
+  "code": "A",//非空
+  "label": "man",//非空
+  "remark": "测试数据"
+}
+删除:
+{
+  "id": ""
+}
+```
+
+#### 映射表替代字典数据的数据集查询
+
+请求路径:/dt/data/result
+
+请求参数
+
+```json
+{
+    "groupCode": "WD",//集团code
+    "type": "sex"//字典类型
+}
+```
+
+#### 字典数据映射
+
+请求路径:/dt/data/map/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
+
+请求参数
+
+```json
+查询字段:
+{
+  "id": "1",
+  "dictDataId": "1",
+  "type": "sex",
+  "groupCode": "WD",
+  "targetCode": "0",
+  "label": "man",
+  "code": "A",
+  "status": 1,
+  "createTime": 1602429745000,
+  "createUser": "test",
+  "updateTime": 1602710687000,
+  "updateUser": "test",
+  "remark": "测试数据"
+}
+新增:
+{
+  "dictDataId": "1",//非空
+  "type": "sex",//非空
+  "groupCode": "WD",//非空
+  "targetCode": "0",//非空
+  "label": "man",//非空
+  "code": "A",//非空
+  "remark": "测试数据"
+}
+更新:
+{
+  "id": "1",//非空
+  "dictDataId": "1",//非空
+  "type": "sex",//非空
+  "groupCode": "WD",//非空
+  "targetCode": "0",//非空
+  "label": "man",//非空
+  "code": "A",//非空
+  "remark": "测试数据"
+}
+删除:
+{
+  "id": ""
+}
+```
+
+
+
+
+
+
+

+ 107 - 0
docs/dic/dic_ddl_sql.md

@@ -0,0 +1,107 @@
+## 数据字典表
+
+### 字典类型
+
+```sql
+DROP TABLE IF EXISTS `dic_dt_type`;
+
+CREATE TABLE dic_dt_type (
+    id varchar(20) NOT NULL PRIMARY KEY,
+    group_code varchar(20) NULL COMMENT '集团编码',
+    type varchar(40) NOT NULL COMMENT '字典类型',
+    name varchar(40) NOT NULL COMMENT '字典类型名称',
+    description varchar(200) NULL COMMENT '描述',
+    status int NOT NULL COMMENT '状态',
+    create_time timestamp NULL COMMENT '创建时间',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    remark varchar(200) NULL COMMENT '备注'
+) COMMENT '字典类型';
+```
+
+### 字典数据
+
+```sql
+DROP TABLE IF EXISTS `dic_dt_data`;
+
+CREATE TABLE dic_dt_data (
+    id varchar(20) NOT NULL PRIMARY KEY,
+    dict_type_id varchar(20) NOT NULL COMMENT '字典类型ID',
+    parent_id varchar(20) NULL COMMENT '父节点',
+    type varchar(40) NOT NULL COMMENT '字典类型',
+    code varchar(40) NOT NULL COMMENT '字典数据编码',
+    label varchar(40) NOT NULL COMMENT '字典数据标签',
+    status int NOT NULL COMMENT '状态',
+    create_time timestamp NULL COMMENT '创建时间',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    remark varchar(200) NULL
+) COMMENT '字典数据';
+```
+
+### 字典数据映射
+
+```sql
+DROP TABLE IF EXISTS `dic_dt_data_map`;
+
+CREATE TABLE dic_dt_data_map (
+    id varchar(20) NOT NULL PRIMARY KEY,
+    dict_data_id varchar(20) NOT NULL COMMENT '字典数据ID',
+    type varchar(40) NOT NULL COMMENT '字典类型',
+    group_code varchar(20) NOT NULL COMMENT '集团编码',
+    target_code varchar(20) NOT NULL COMMENT '映射字典数据表code',
+    label varchar(40) NOT NULL COMMENT '字典数据标签',
+    code varchar(40) NOT NULL COMMENT '字典数据编码',
+    status int NOT NULL COMMENT '状态',
+    create_time timestamp NULL COMMENT '创建时间',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    remark varchar(200) NULL COMMENT '备注'
+) COMMENT '字典数据映射';
+```
+
+## 知识库表
+
+### 知识库类型
+
+```sql
+DROP TABLE IF EXISTS `dic_kl_type`;
+
+CREATE TABLE dic_kl_type (
+    id varchar(20) NOT NULL PRIMARY KEY,
+    code varchar(40) NOT NULL COMMENT '知识库编码',
+    name varchar(40) NOT NULL COMMENT '知识库名称',
+    description varchar(500) NULL COMMENT '描述',
+    status int NOT NULL COMMENT '状态',
+    create_time timestamp NULL COMMENT '创建时间',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    remark varchar(200) NULL COMMENT '备注'
+) COMMENT '知识库类型';
+```
+
+### 知识库数据
+
+```sql
+DROP TABLE IF EXISTS `dic_kl_data`;
+
+CREATE TABLE dic_kl_data (
+    id varchar(20) NOT NULL PRIMARY KEY,
+    kl_type_code varchar(20) NOT NULL COMMENT '知识库类型编码',
+    kl_type_name varchar(40) NOT NULL COMMENT '知识库类型名称',
+    parent_id varchar(20) NULL COMMENT '父节点',
+    code varchar(40) NOT NULL COMMENT '知识库数据编码',
+    label varchar(40) NOT NULL COMMENT '知识库数据标签',
+    value varchar(500) NULL COMMENT '知识库数据内容',
+    status int NOT NULL COMMENT '状态',
+    create_time timestamp NULL COMMENT '创建时间',
+    create_user varchar(40) NULL COMMENT '创建用户',
+    update_time timestamp NULL COMMENT '更新时间',
+    update_user varchar(40) NULL COMMENT '更新用户',
+    remark varchar(200) NULL COMMENT '备注'
+) COMMENT '知识库数据';
+```

+ 60 - 0
docs/dic/dic_design.md

@@ -0,0 +1,60 @@
+# 统一数据标准化
+
+数据字典主要用于维护系统常用且固定的数据类型,例如:性别(1:男,2:女)
+
+datetime格式:时间戳(1598495680898)
+
+## 数据结构
+
+### 字典类型结构(dict_type)
+
+|    字段     |      字段说明      |   数据类型   | 是否非空 |               备注                |
+| :---------: | :----------------: | :----------: | -------- | :-------------------------------: |
+|     id      | 主键(无业务含义) | varchar(20)  | Y        | id全局唯一,命名规则:“Dict”+UUID |
+| group_code  |      集团编码      | varchar(20)  |          |                                   |
+|    type     |      字典类型      | varchar(40)  | Y        |                sex                |
+|    name     |    字典类型名称    | varchar(40)  | Y        |               性别                |
+| description |        描述        | varchar(200) |          |          对字典类型描述           |
+|   status    |        状态        |   char(2)    |          |         0:停用,1:正常          |
+| create_time |      创建时间      |   datetime   |          |                                   |
+| create_user |      创建人员      | varchar(40)  |          |         保存创建的用户id          |
+| update_time |      更新时间      |   datetime   |          |                                   |
+| update_user |      更新人员      | varchar(40)  |          |       保存最后更新的用户id        |
+|   remark    |      备注信息      | varchar(200) |          |                                   |
+
+### 字典数据结构(dict_data)
+
+|     字段     |      字段说明      |   数据类型   | 是否非空 |                 备注                 |
+| :----------: | :----------------: | :----------: | -------- | :----------------------------------: |
+|      id      | 主键(无业务含义) | varchar(20)  | Y        |                 UUID                 |
+| dict_type_id |     字典类型id     | varchar(20)  | Y        |                                      |
+| parent_code  |       父节点       | varchar(20)  |          | 保存多级树状字典(id),没有可以不写 |
+|     type     |      字典类型      | varchar(40)  | Y        |         对应字典类型(sex)          |
+|     code     |        编码        | varchar(40)  | Y        |                  1                   |
+|    label     |      字典标签      | varchar(40)  | Y        |                  男                  |
+|    status    |        状态        |   char(2)    | Y        |           0:停用,1:正常           |
+|    remark    |      备注信息      | varchar(200) |          |                                      |
+
+### 字典数据映射结构(dict_data_map)
+
+
+
+|     字段     |       字段说明       |   数据类型   |      |           备注           |
+| :----------: | :------------------: | :----------: | ---- | :----------------------: |
+|      id      |  主键(无业务含义)  | varchar(20)  | Y    | 全局唯一,UUID无实际意义 |
+| dict_data_id |    字典数据结构id    | varchar(20)  | Y    |      对应字典数据id      |
+|     type     |       字典类型       | varchar(40)  | Y    |       对应字典类型       |
+|  group_code  |       集团编码       | varchar(20)  | Y    |                          |
+| target_code  | 映射的字典数据表code | varchar(20)  | Y    |            1             |
+|    label     |       字典标签       | varchar(40)  | Y    |           男性           |
+|     code     |         编码         | varchar(40)  | Y    |            a             |
+|    status    |         状态         |   char(2)    | Y    |     0:停用,1:正常     |
+| create_time  |       创建时间       |   datetime   |      |                          |
+| create_user  |       创建人员       | varchar(40)  |      |     保存创建的用户ID     |
+| update_time  |       更新时间       |   datetime   |      |                          |
+| update_user  |       更新人员       | varchar(40)  |      |   保存最后更新的用户ID   |
+|    remark    |       备注信息       | varchar(200) |      |                          |
+
+
+
+

+ 10 - 0
docs/dic/index.md

@@ -0,0 +1,10 @@
+## 数据标准化
+
+#### [建表语句](/dic/dic_ddl_sql.md)
+
+#### [接口文档](/dic/dic_api.md)
+
+#### [数据结构设计](/dic/dic_design.md)
+
+
+

+ 68 - 0
docs/dic/knowledge.md

@@ -0,0 +1,68 @@
+# 知识库
+
+### 数据模型
+
+1. 知识库类型
+2. 知识库数据
+
+### 数据关说明
+
+1. 知识库中的数据,原则上只做增加
+2. 知识库类型保存知识库数据对应的大类
+3. 知识库数据保存实际的知识库类型对应的知识数据
+
+### 数据结构
+
+| 知识库类型(kl_tpye) |                    |              |                                 |
+| :-------------------: | :----------------: | :----------: | :-----------------------------: |
+|         字段          |      字段说明      |   数据类型   |              备注               |
+|          id           | 主键(无业务含义) | varchar(20)  | id全局唯一,命名规则:“KL”+UUID |
+|         code          |     知识库编码     | varchar(40)  |                                 |
+|         name          |   知识库类型名称   | varchar(40)  |                                 |
+|      description      |        描述        | varchar(500) |        对知识库类型描述         |
+|        status         |        状态        |   char(2)    |        0:停用,1:正常         |
+|      create_time      |      创建时间      |   datetime   |                                 |
+|       create_by       |      创建人员      | varchar(40)  |        保存创建的用户id         |
+|      update_time      |      更新时间      |   datetime   |                                 |
+|       update_by       |      更新人员      | varchar(40)  |      保存最后更新的用户id       |
+|        remark         |      备注信息      | varchar(200) |                                 |
+
+| 知识库数据(kl_data) |                    |              |                                        |
+| :-------------------: | :----------------: | :----------: | :------------------------------------: |
+|         字段          |      字段说明      |   数据类型   |                  备注                  |
+|          id           | 主键(无业务含义) | varchar(20)  |                  UUID                  |
+|      kl_tpye_id       |    知识库类型id    | varchar(20)  |                                        |
+|      parent_code      |       父节点       | varchar(20)  | 保存多级树状知识库(id),没有可以不写 |
+|     kl_type_code      |     知识库类型     | varchar(40)  |           对应知识库类型编码           |
+|         code          |        编码        | varchar(40)  |                                        |
+|         label         |        名称        | varchar(40)  |                                        |
+|         value         |   知识库其他字段   | varchar(500) |              保存json格式              |
+|        status         |        状态        |   char(2)    |            0:停用,1:正常            |
+|        remark         |      备注信息      | varchar(200) |                                        |
+
+
+
+## 接口
+
+```json
+{
+  "code":"",
+  "name":"",
+  "userId":"",
+  "description":"知识库类型描述",
+  "data":[
+    { 
+      "parentCode":"",//用于多层级知识库数据,没有可为空
+      "kl_tpye_id":"",
+      "code":"",
+      "label":"",
+      "value":[
+        {
+          //根据值拼装json字符串
+        }
+      ]
+    }
+  ]
+}
+```
+

+ 22 - 29
docs/org/org_api.md

@@ -145,39 +145,28 @@ POST: /example/delete
 
 ### (注:为了读写分离,serviceid还会变动,请不要写死)
 
-### (注:userId、groupCode必须传值,appId可以为空)
+### (注:userId、groupCode、projectId必须传值,appId可以为空)
 
 #### 请求方法:POST
 
-#### 集团
+#### 集团(只提供查询接口)
 
-请求路径:/group/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/group/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
 ```json
-新增:
-{
-  "code": "WD",//非空
-  "name": "万达",//非空
-  "remark": "测试数据"
-}
-更新(注:全量更新):
-{
-  "id": "1",//非空
-  "code": "WD",//非空
-  "name": "万达",//非空
-  "remark": "测试数据"
-}
-删除:
+查询字段:
 {
-  "id": "1"
+  "id": "1",
+  "code": "WD",
+  "name": "万达",
 }
 ```
 
 #### 公司
 
-请求路径:/company/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/company/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -187,7 +176,11 @@ POST: /example/delete
   "code": "WD_CP_01",//非空
   "name": "万达测试1",//非空
   "parentId": "1",//非空
-  "remark": "测试数据"
+  "remark": "测试数据",
+  "projects": [
+    {"id": "1"},
+    {"id": "3"}
+  ]//projects 给公司配置项目的id
 }
 更新(注:全量更新):
 {
@@ -208,7 +201,7 @@ POST: /example/delete
 ```
 #### 项目
 
-请求路径:/project/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/project/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -232,7 +225,7 @@ POST: /example/delete
 ```
 #### 人员账号
 
-请求路径:/user/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/user/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -275,7 +268,7 @@ POST: /example/delete
 ```
 #### 部门
 
-请求路径:/dept/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/dept/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -311,7 +304,7 @@ POST: /example/delete
 
 #### 部门分类
 
-请求路径: /dept/classify/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径: /dept/classify/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -340,7 +333,7 @@ POST: /example/delete
 ```
 #### 岗位
 
-请求路径:/job/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/job/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -374,7 +367,7 @@ POST: /example/delete
 ```
 #### 岗位分类
 
-请求路径:/job/classify/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/job/classify/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -402,7 +395,7 @@ POST: /example/delete
 
 #### 应用
 
-请求路径:/application/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/application/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -439,7 +432,7 @@ POST: /example/delete
 ```
 #### 功能
 
-请求路径:/function/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/function/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 
@@ -482,7 +475,7 @@ POST: /example/delete
 ```
 #### 岗位分类与应用功能关系
 
-请求路径:/job/classify/rel/{condition}?userId=用户id&groupCode=集团编码&appId=应用id
+请求路径:/job/classify/rel/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
 

+ 2 - 1
docs/org/org_ddl_sql.md

@@ -75,7 +75,8 @@ CREATE TABLE org_user (
     head_portrait varchar(80) NULL COMMENT '头像',
     other_account varchar(80) NULL COMMENT '第三方账号',
     user_from varchar(80) NULL COMMENT '账号来源',
-    isAdmin varchar(80) NULL COMMENT '是否为PERSAGYADMIN',
+    group_code varchar(80) NOT NULL COMMENT '所属集团',
+    is_admin varchar(80) NULL COMMENT '是否为PERSAGYADMIN',
     status int NOT NULL COMMENT '状态',
     create_user varchar(80) NULL COMMENT '创建用户',
     create_time timestamp NULL COMMENT '创建时间',

+ 2 - 1
docs/org/org_design.md

@@ -73,7 +73,8 @@
 | mail          | 邮箱                                                 |      |                          |
 | other_account | 第三方账号                                           |      |                          |
 | user_from     | 账号来源,0-FM账号,1-苏宁账号,2-万达账号,3-新城OA账号 |      |                          |
-| isAdmin       | 是否为PERSAGYADMIN,0-不是,1-是                       |      |                          |
+| group_code    | 所属集团                                              | Y    | 集团编码                        |
+| is_admin       | 是否为PERSAGYADMIN,0-不是,1-是                       |      |                          |
 | status        | 状态                                                 | Y    | 是否有效                 |