Browse Source

人员添加批量增删改接口,调整目录格式

wudla 4 years ago
parent
commit
1c8197627d

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

@@ -13,7 +13,7 @@ module.exports = {
             { text: '报警系统', link: '/alarm/'}
             ],
 
-        sidebarDepth: 1,
+        sidebarDepth: 2,
         displayAllHeaders: true,
         sidebar: {
             '/utils/query': [

+ 25 - 12
docs/alarm/alarm_api.md

@@ -2,21 +2,24 @@
 
 ## 系统接口
 
-### (注:condition 为 query,create,update,delete)
+> #### (注:condition 为 query,create,update,delete)
+>
+> #### (注:为了读写分离,serviceid还会变动,请不要写死)
+>
+> #### (注:userId、groupCode、projectId必须传值,appId可以为空)
+>
+> #### 请求方法:POST
 
-### (注:为了读写分离,serviceid还会变动,请不要写死)
-
-### (注:userId、groupCode、projectId必须传值,appId可以为空)
-
-#### 请求方法:POST
 #### 查询
 
 [通用查询](/utils/query.md)
 
-#### 报警条目(注:condition 为 query)
+### 报警条目
 
 请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query)
+
 请求参数:
 
 ```json
@@ -38,10 +41,12 @@
 }
 ```
 
-#### 报警匹配规则(注:condition 为 query,create,update,delete)
+### 报警匹配规则
 
 请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query,create,update,delete)
+
 请求参数:
 
 ```json
@@ -84,10 +89,12 @@
 }
 ```
 
-#### 报警定义(注:condition 为 query,update)
+### 报警定义
 
 请求路径:/alarm/config/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query,update)
+
 请求参数:
 
 ```json
@@ -127,10 +134,12 @@
 }
 ```
 
-####  报警记录(注:condition 为 query,create,update)
+###  报警记录
 
 请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query,create,update)
+
 请求参数:
 
 ```json
@@ -186,10 +195,12 @@
 }
 ```
 
-#### 报警日志(注:condition 为 query,create)
+### 报警日志
 
 请求路径:/alarm/log/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query,create)
+
 请求参数:
 
 ```json
@@ -211,10 +222,12 @@
 }
 ```
 
-#### 报警批注(注:condition 为 query,create)
+### 报警批注
 
 请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
+(注:condition 为 query,create)
+
 请求参数:
 
 ```json

+ 11 - 136
docs/dic/dic_api.md

@@ -1,145 +1,20 @@
 # 数据标准化接口文档
 
-### 查询(请参考[通用查询](/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还会变动,请不要写死)
+> #### (注:condition 为 query,create,update,delete)
+>
+> #### (注:为了读写分离,serviceid还会变动,请不要写死)
+>
+> #### (注:userId、groupCode、projectId必须传值,appId可以为空)
+>
+> #### 请求方法:POST
 
-### (注:userId、groupCode、projectId必须传值,appId可以为空)
-
-#### 请求方法:POST
+### 查询(请参考[通用查询](/utils/query.md))
 
-#### 字典类型
+### 字典类型
 
 请求路径:/dt/type/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -181,7 +56,7 @@ POST: /example/delete
 }
 ```
 
-#### 字典数据
+### 字典数据
 
 请求路径:/dt/data/query/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -241,7 +116,7 @@ POST: /example/delete
 }
 ```
 
-#### 字典数据映射
+### 字典数据映射
 
 请求路径:/dt/data/map/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 

+ 5 - 1
docs/dic/dic_design.md

@@ -6,6 +6,8 @@ datetime格式:时间戳(1598495680898)
 
 ## 数据结构
 
+
+
 ### 字典类型结构(dic_dt_type)
 
 |    字段     |      字段说明      |   数据类型   | 是否非空 |               备注                |
@@ -22,6 +24,8 @@ datetime格式:时间戳(1598495680898)
 | update_user |      更新人员      | varchar(40)  |          |       保存最后更新的用户id        |
 |   remark    |      备注信息      | varchar(200) |          |                                   |
 
+
+
 ### 字典数据结构(dic_dt_data)
 
 |     字段     |      字段说明      |   数据类型   | 是否非空 |                 备注                 |
@@ -35,9 +39,9 @@ datetime格式:时间戳(1598495680898)
 |    status    |        状态        |   char(2)    | Y        |           0:停用,1:正常           |
 |    remark    |      备注信息      | varchar(200) |          |                                      |
 
-### 字典数据映射结构(dic_dt_data_map)
 
 
+### 字典数据映射结构(dic_dt_data_map)
 
 |     字段     |       字段说明       |   数据类型   |      |           备注           |
 | :----------: | :------------------: | :----------: | ---- | :----------------------: |

+ 2 - 2
docs/dpt/dpt_api.md

@@ -2,7 +2,7 @@
 
 ## 系统接口
 
-#### 查询
+### 查询
 
 请参考[通用查询](/utils/query.md)
 
@@ -205,7 +205,7 @@
 }
 ```
 
-## 任务记录
+### 任务记录
 
 请求方法:POST
 

+ 13 - 17
docs/dpt/dpt_design.md

@@ -2,11 +2,10 @@
 
 ## 数据结构
 
-### 数据结构
+### 任务调度配置
 
-| 任务调度配置 |          |      |                                          |        |                                          |
-| ------------ | -------- | ---- | ---------------------------------------- | ------ | ---------------------------------------- |
 | 参数名       | 类型     | 必填 | 描述                                     | 默认值 | 备注                                     |
+| ------------ | -------- | ---- | ---------------------------------------- | ------ | ---------------------------------------- |
 | id           | String   | Y    |                                          | UUID   | 新建时如果为空,则默认为UUID             |
 | groupCode    | String   |      | 所属集团编码                             |        |                                          |
 | appCode      | String   |      | 应用编码                                 |        |                                          |
@@ -49,18 +48,15 @@ params
 }
 ```
 
-
-
-
-
-| 任务执行记录 |              |             |      |                            |
-| ------------ | ------------ | ----------- | ---- | -------------------------- |
-| 字段         | 字段名称     | 类型        | 非空 | 备注                       |
-| id           | ID           | varchar(40) | Y    | 全局唯一                   |
-| task_id      | 任务ID       | varchar(40) | Y    |                            |
-| start_time   | 开始时间     | datetime    |      |                            |
-| end_time     | 结束时间     | datetime    |      |                            |
-| success      | 是否正常结束 | bit         | Y    | 1是,0否,否表示发生了异常 |
-| error_info   | 错误信息     | json        | Y    |                            |
-|              |              |             |      |                            |
+### 任务执行记录
+
+| 字段       | 字段名称     | 类型        | 非空 | 备注                       |
+| ---------- | ------------ | ----------- | ---- | -------------------------- |
+| id         | ID           | varchar(40) | Y    | 全局唯一                   |
+| task_id    | 任务ID       | varchar(40) | Y    |                            |
+| start_time | 开始时间     | datetime    |      |                            |
+| end_time   | 结束时间     | datetime    |      |                            |
+| success    | 是否正常结束 | bit         | Y    | 1是,0否,否表示发生了异常 |
+| error_info | 错误信息     | json        | Y    |                            |
+|            |              |             |      |                            |
 

+ 81 - 79
docs/org/org_api.md

@@ -1,18 +1,20 @@
 # 人员组织权限接口文档
 
-### 查询(请参考[通用查询](/utils/query.md))
-
 ## 系统接口
 
-### (注:condition 为 query,create,update,delete)
-
-### (注:为了读写分离,serviceid还会变动,请不要写死)
+> #### (注:condition 为 query,create,update,delete)
+>
+> #### (注:为了读写分离,serviceid还会变动,请不要写死)
+>
+> #### (注:userId、groupCode、projectId必须传值,appId可以为空)
+>
+> #### 请求方式:POST
 
-### (注:userId、groupCode、projectId必须传值,appId可以为空)
+### 查询
 
-#### 请求方法:POST
+### [通用查询](/utils/query.md)
 
-#### 集团(只提供查询接口)
+### 集团(只提供查询接口)
 
 请求路径:/group/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -33,7 +35,7 @@
 }
 ```
 
-#### 公司
+### 公司
 
 请求路径:/company/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -55,8 +57,8 @@
   "remark": "测试数据"
 }
 "withColumns" 可用字段 "projects"
-新增:
-{
+新增:[{},{}]
+[{
   "code": "WD_CP_01",//非空
   "name": "万达测试1",//非空
   "parentId": "1",//非空
@@ -65,9 +67,9 @@
     {"id": "1"},
     {"id": "3"}
   ]//projects 给公司配置项目的id
-}
-更新(注:全量更新):
-{
+}]
+更新:[{},{}]
+[{
   "id": "1",//非空
   "code": "WD_CP_01",//非空
   "name": "万达测试1",//非空
@@ -77,13 +79,13 @@
     {"id": "1"},
     {"id": "3"}
   ]//projects 给公司配置项目的id
-}
-删除:
-{
+}]
+删除:[{},{}]
+[{
   "id": "1"
-}
+}]
 ```
-#### 项目
+### 项目
 
 请求路径:/project/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -101,24 +103,24 @@
   "remark": "测试数据"
 }
 "withColumns" 可用字段 "companies"
-新增:
-{
+新增:[{},{}]
+[{
   "id": "3",//非空,业务维护项目Id字段
   "name": "测试项目3",//非空
   "remark": "测试数据"
-}
-更新(注:全量更新):
-{
+}]
+更新:[{},{}]
+[{
   "id": "3",//非空
   "name": "测试项目3",//非空
   "remark": "测试数据"
-}
-删除:
-{
+}]
+删除:[{},{}]
+[{
   "id": "1"
-}
+}]
 ```
-#### 人员账号
+### 人员账号
 
 请求路径:/user/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -167,7 +169,7 @@
   }
 ]
 更新:[{},{}]
-{
+[{
   "id": "1",
   "name": "King",
   "username": "king",
@@ -182,7 +184,7 @@
   "groupCode": "集团code",
   "isAdmin": "0",
   "remark": "测试数据"
-}
+}]
 删除:[{},{}]
 [
   {
@@ -190,7 +192,7 @@
 	}
 ]
 ```
-#### 部门
+### 部门
 
 请求路径:/dept/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -251,7 +253,7 @@
 ]
 ```
 
-#### 部门分类
+### 部门分类
 
 请求路径: /dept/classify/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -273,29 +275,29 @@
   "updateTime": 1602637584000,
   "remark": "测试数据"
 }
-新增:
-{
+新增:[{},{}]
+[{
   "code": "DEV",//非空
   "name": "开发",//非空
   "parentId": "0",
   "orderNum": 1,
   "remark": "测试数据"
-}
-更新(注:全量更新):
-{
+}]
+更新:[{},{}]
+[{
   "id": "1",//非空
   "code": "DEV",//非空
   "name": "开发",//非空
   "parentId": "0",
   "orderNum": 1,
   "remark": "测试数据"
-}
-删除:
-{
+}]
+删除:[{},{}]
+[{
   "id": "1"
-}
+}]
 ```
-#### 岗位
+### 岗位
 
 请求路径:/job/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -319,8 +321,8 @@
   "updateTime": 1602635887000,
   "remark": "测试数据"
 }
-新增:
-{
+新增:[{},{}]
+[{
   "code": "DEV_JAVA",//建议非空
   "name": "Java开发",//建议非空
   "groupCode": "WD",//非空
@@ -329,9 +331,9 @@
   "jobClassifyCode": "DEV_JAVA_CLASS",//非空
   "resourceFrom": "0",
   "remark": "测试数据"
-}
-更新(注:全量更新):
-{
+}]
+更新:[{},{}]
+[{
   "id": "1",//非空
   "code": "DEV_JAVA",//建议非空
   "name": "Java开发",//建议非空
@@ -340,13 +342,13 @@
   "jobClassifyCode": "DEV_JAVA_CLASS",//非空
   "resourceFrom": "0",
   "remark": "测试数据"
-}
-删除:
-{
+}]
+删除:[{},{}]
+[{
   "id": "1"
-}
+}]
 ```
-#### 岗位分类
+### 岗位分类
 
 请求路径:/job/classify/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -394,7 +396,7 @@
 ]
 ```
 
-#### 应用
+### 应用
 
 请求路径:/application/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -419,8 +421,8 @@
   "updateTime": 1602638597000,
   "remark": "测试数据"
 }
-新增:
-{
+新增:[{},{}]
+[{
   "code": "DMP",//非空
   "name": "数据中台",//非空
   "category": "运维",//非空
@@ -430,9 +432,9 @@
   "description": "测试des",
   "objType": "test_type",
   "remark": "测试数据"
-}
-更新(注:全量更新)
-{
+}]
+更新:
+[{
   "id": "1",//非空
   "code": "DMP",//非空
   "name": "数据中台",//非空
@@ -443,13 +445,13 @@
   "description": "测试des",
   "objType": "test_type",
   "remark": "测试数据"
-}
+}]
 删除:
-{
+[{
   "id": "1"
-}
+}]
 ```
-#### 功能
+### 功能
 
 请求路径:/function/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -477,8 +479,8 @@
   "updateTime": 1602638923000,
   "remark": "测试数据"
 }
-新增:
-{
+新增:[{},{}]
+[{
   "code": "DMP_FUNC",//非空
   "name": "数据中台功能",//非空
   "type": "test",
@@ -491,9 +493,9 @@
   "objType": "test_type",
   "funcOrder": 1,
   "remark": "测试数据"
-}
-更新(注:全量更新):
-{
+}]
+更新:[{},{}]
+[{
   "id": "1",//非空
   "code": "DMP_FUNC",//非空
   "name": "数据中台功能",//非空
@@ -507,13 +509,13 @@
   "objType": "test_type",
   "funcOrder": 1,
   "remark": "测试数据"
-}
-删除:
-{
+}]
+删除:[{},{}]
+[{
   "id": "1"
-}
+}]
 ```
-#### 岗位分类与应用功能关系
+### 岗位分类与应用功能关系
 
 请求路径:/job/classify/rel/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -534,14 +536,14 @@
   "updateTime": 1602637476000,
   "remark": "测试数据"
 }
-新增:
-{
+新增:[{},{}]
+[{
   "jobClassifyCode": "DEV_JAVA_CLASS",//非空
   "appId": "1",
   "functionId": "1",
   "remark": "测试数据"
-}
-更新(注:全量更新):
+}]
+更新:[{},{}]
 {
   "id": "1",//非空
   "jobClassifyCode": "DEV_JAVA_CLASS",
@@ -555,7 +557,7 @@
 }
 ```
 
-#### 集团与应用的关系
+### 集团与应用的关系
 
 请求路径:/group/app/rel/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -599,7 +601,7 @@
 ]
 ```
 
-#### 集团与功能的关系
+### 集团与功能的关系
 
 请求路径:/group/function/rel/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 

+ 6 - 3
docs/org/org_design.md

@@ -1,7 +1,10 @@
-# 人员组织权限数据结构
+# 人员组织权限设计
 
-#### 注:集团,岗位分类,部门分类使用code关联,id没有实际意义,其他表均以id进行关联
-#### 注:除了项目id为公司自行维护,其余id均为UUID
+> #### 注:集团,岗位分类,部门分类使用code关联,id没有实际意义,其他表均以id进行关联
+>
+> #### 注:除了项目id为公司自行维护,其余id均为UUID
+
+## 数据结构
 
 ### 1、集团 org_group