接口文档更新

gitbook/dev/README.md

@@ -3,10 +3,12 @@
 # BI商业智能平台 - 研发设计文档
 
 ##### 编写人
-`肖春腾`
+`肖春腾，祝通鸿`
 ##### 编写日期
 `2018/07/31`
 
+`最后修改日期：2018/10/8`
+
 | 文档版本号 	| 文档密级  	| 项目编号 	| 归属部门/项目 	|
 |------------	|-----------	|----------	|---------------	|
 | V1.0       	| 机密文件  	|          	|               	|

gitbook/dev/appendix.md

@@ -1,9 +1,5 @@
 # 附录
 ###	前端框架结构
-- 使用React系列技术以及antd的组件实现的单页应用（Single Page Application)
-- 全局使用[dva框架](https://dvajs.com/guide/)实现全局或局部数据流沟通；目前共有4个model：
-    -	main.js：用于提供全站可用的redirect方法
-    -	chartDesigner.js: 用于图表编辑模块内的全局通信，加载当前选中的图表配置信息
-    -	dataConnect.js：用于数据源模块的数据连接工具信息储存，加载当前用户可用的数据连接工具信息
-    -	dataSource.js：用于数据源模块数据源配置信息储存，加载当前用户可用的数据源配置信息
--	全局使用dva框架中集成的dva/router模块实现路由功能
+- 使用React系列技术以及antd的组件（含部分pro组件）实现的单页应用（Single Page Application)
+- 全局使用[dva框架](https://dvajs.com/guide/)实现全局或局部数据流沟通
+- 全局使用dva框架中集成的dva/router模块实现路由功能

gitbook/dev/interface-chart.md

@@ -4,32 +4,25 @@
 `/inputCharts`
 ##### 请求方式: 
 `HTTP - POST`
-#####包类方法:  
-`dispatch(type:'chart/remoteAdd')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端）              	| 说明              	|
-|----------------	|-----------------------------	|-------------------	|
-| chartName      	| header.label                	| 图表标题          	|
-| dataId         	| baseConfig.dataSource       	| 基础配置 – 数据源 	|
-| groupBy{       	|                             	| 预处理 – 分组     	|
-| columnName     	| preparing.groupBy.key       	| 分组列列名        	|
-| columnRamane   	| preparing.groupBy.label     	| 分组列别名        	|
-| }]             	|                             	|                   	|
-| createBy       	|                             	| 创建人            	|
-| describes      	| description                 	| 说明              	|
-| style          	|                             	| 样式配置          	|
-| otherConfig    	| JSON.stringify(otherConfig) 	| 其他配置          	|
-| chartType      	| base.viewType               	| 可视化模式        	|
-| chartConfig    	|                             	| 图表配置          	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| chartName | String | 图表标题 |
+| dataId | Number | 数据源id |
+| describes | String | 描述 |
+| style | String | 样式 |
+| otherConfig | String | 其他设置 |
+| chartsGroup | Number | 所属分组 |
+| filters | String | 过滤条件 |
+| chartType | enum : [ "Histogram", "Pie", "Line", "scatter", "population", "individual"]| 可视化模式        	|
+| chartConfig | String | 图表配置 |
 
 ##### 请求示例
 ```json
 {
     "chartName": "文档测试1(未命名)",
     "dataId": 71,
-    "groupBy": [],
-    "createBy": "zhuth",
     "describes": "",
     "style": "",
     "chartConfig": "{}",
@@ -54,8 +47,6 @@ ___
 `/updateCharts`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteModify')`
 ##### 请求参数
 
 ChartID: code （图表编号） 其余同新增图表
@@ -93,8 +84,6 @@ ___
 `/delChartsConfig`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteDelete')`
 ##### 请求参数
 
 Code （图表编号）  
@@ -108,8 +97,6 @@ ___
 `/getListCharts`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/fetchList')`
 ##### 请求参数
 空
 ##### 返回结果
@@ -201,8 +188,6 @@ ___
 `/getChartsConfig`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteDetail')`
 ##### 请求参数
 
 Code (图表编号)
@@ -251,27 +236,16 @@ ___
 
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/fetchBarData')`
-`dispatch(type:'chart/fetchLineData')`
-`dispatch(type:'chart/fetchPieData')`
-`dispatch(type:'chart/fetchScatterData')`
-`dispatch(type:'chart/fetchDataViewData')`
 
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端）                    	| 说明        	|
-|----------------	|-----------------------------------	|-------------	|
-| id             	| code                              	| 图表编号    	|
-| groups         	| preparing.groupBy.key             	| 分组列列名  	|
-| xAxis          	|                                  	| X轴         	|
-| columnRename   	| barConfig.xAxis.column.value      	| X轴列名     	|
-| columnType     	| barConfig.xAxis.column.type       	| X轴分析类型 	|
-| showDataType   	| barConfig.xAxis.granularity.value 	| X轴粒度     	|
-| yAxis          	|                                  	| Y轴         	|
-| columnRename   	| barConfig.yAxis.column.value      	| Y轴列名     	|
-| showDataType   	| barConfig.yAxis.gauge.value       	| Y轴统计方式 	|
-
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| id | Number | 图表编号 |
+| groups | Array | 分组列列名 |
+| xAxis | Object : { columnRename: "列名", columnType: "列类型", showDataType: "统计方式" } | X轴 |
+| yAxis | Object : { columnRename: "列名", showDataType: "统计方式"}| Y轴 |
+| filters | Array | 过滤条件 |
 ##### 请求示例
 ##### 返回结果
 ##### 详细说明
@@ -285,8 +259,6 @@ ___
 `/getChartsGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteGroupList')`
 ##### 请求参数
 
 空 
@@ -303,16 +275,13 @@ ___
 ##### 请求路径 
 `/setChartsGroup`
 #####请求方式`HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteAddGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| fatherId | Number | 父级分组ID |
+| groupName | String| 组名 |
+| groupIndex | Number | 顺序号 |
 
 ##### 请求示例
 ##### 返回结果
@@ -324,17 +293,14 @@ ___
 `/updataChartsGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteModifyGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| Id             	| Group.code     	| 分组ID            	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
+| 字段名 | 类型 | 说明 |
+|--- | --- | --- |
+| Id | Number | 分组ID |
+| fatherId | Number | 父级分组ID |
+| groupName | String | 组名 |
+| groupIndex | Number | 顺序号 |
 
 ##### 请求示例
 ##### 返回结果
@@ -345,14 +311,12 @@ ___
 `/updateChartConfigGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteSetChartGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明       	|
-|----------------	|----------------	|------------	|
-| Id             	| DatasourceCode 	| 数据源ID   	|
-| GroupID        	| “新子分组”’    	| 目标分组ID 	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| Id | Number | 数据源ID |
+| GroupID | Number | 目标分组ID |
 
 ##### 请求示例
 ##### 返回结果
@@ -363,8 +327,6 @@ ___
 `/updataListGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteModifyGroups')`
 ##### 请求参数
 
 id : code  
@@ -378,8 +340,6 @@ ___
 `/delChartsGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chart/remoteDeleteGroup')`
 ##### 请求参数
 
 Code ID
@@ -388,85 +348,23 @@ Code ID
 ##### 返回结果
 ##### 详细说明
 ___
-## 图表编辑器
-##  获得数据源下的列数据
+##  图表移交
 ##### 请求路径 
-`/getColumnData`
+`/changeChartOrder`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'chartDesigner/remoteDataColumn')`
 ##### 请求参数
-
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
-
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| userId | Number | 被移交人id |
+| id | Number | 图表id |
 ##### 请求示例
 ```json
-71
-```
-##### 返回结果
-```json
 {
-    "data": {
-        "code": 200,
-        "msg": "成功",
-        "data": [{
-            "columnName": "BC_CODE",
-            "columnRaname": "编号",
-            "columnType": "categorical",
-            "isGroup": "1",
-            "isSubsection": "0"
-        }, {
-            "columnName": "BC_DESC",
-            "columnRaname": "工作台说明",
-            "columnType": "categorical",
-            "isGroup": "1",
-            "isSubsection": "0"
-        }, {
-            "columnName": "BC_DETNO",
-            "columnRaname": "序号",
-            "columnType": "scale",
-            "isGroup": "0",
-            "isSubsection": "1"
-        }, {
-            "columnName": "BC_ICON",
-            "columnRaname": "图标",
-            "columnType": "categorical",
-            "isGroup": "1",
-            "isSubsection": "0"
-        }, {
-            "columnName": "BC_ID",
-            "columnRaname": "ID",
-            "columnType": "scale",
-            "isGroup": "0",
-            "isSubsection": "1"
-        }, {
-            "columnName": "BC_TITLE",
-            "columnRaname": "工作台标题",
-            "columnType": "categorical",
-            "isGroup": "1",
-            "isSubsection": "0"
-        }, {
-            "columnName": "BC_URLCOND",
-            "columnRaname": "链接条件",
-            "columnType": "categorical",
-            "isGroup": "1",
-            "isSubsection": "0"
-        }, {
-            "columnName": "BC_USED",
-            "columnRaname": "是否使用",
-            "columnType": "scale",
-            "isGroup": "0",
-            "isSubsection": "1"
-        }]
-    }
+    "userId": "23",
+    "id": "145"
 }
-```
+```        
+##### 返回结果
 ##### 详细说明
-此处将整个groups集体上传 集体替换。
-此处建议使用batch表达批量修改的概念。
+___

gitbook/dev/interface-dashboard.md

@@ -0,0 +1,182 @@
+# 数据接口 - 看板
+##  获得看板列表
+##### 请求路径: 
+`/getListDashboards`
+##### 请求方式: 
+`HTTP - POST`
+##### 请求参数
+无
+
+##### 请求示例
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": {
+            "pageNum": 1,
+            "pageSize": 999,
+            "size": 1,
+            "orderBy": null,
+            "startRow": 1,
+            "endRow": 1,
+            "total": 1,
+            "pages": 1,
+            "list": [{
+                "id": 331,
+                "bdName": "样例看板",
+                "bdNote": null,
+                "bdConfiguration": "[{\"code\":\"709\",\"chartCode\":\"709\",\"name\":\"毛利润组成分析（按物料）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"17\",\"dataSourceName\":\"销售报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"bar\",\"layout\":{\"x\":0,\"y\":0,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"712\",\"chartCode\":\"712\",\"name\":\"呆滞库存分析（饼状图）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"pie\",\"layout\":{\"x\":0,\"y\":6,\"w\":12,\"h\":15,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"710\",\"chartCode\":\"710\",\"name\":\"呆滞库存分析（单笔记录）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"dataView\",\"layout\":{\"x\":0,\"y\":21,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null}]",
+                "thumbnail": "...",
+                "createBy": "祝通鸿",
+                "createId": 16,
+                "relationColumns": null,
+                "createDate": "2018-09-29 17:16:23.0",
+                "updateDate": null,
+                "reDate": null
+            }],
+            "firstPage": 1,
+            "prePage": 0,
+            "nextPage": 0,
+            "lastPage": 1,
+            "isFirstPage": true,
+            "isLastPage": true,
+            "hasPreviousPage": false,
+            "hasNextPage": false,
+            "navigatePages": 8,
+            "navigatepageNums": [1]
+        }
+    }
+}
+```
+##### 详细说明
+___
+##  获得单个看板
+##### 请求路径
+`/getDashboards`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+
+看板id
+
+##### 请求示例
+```
+331
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": {
+            "id": 331,
+            "bdName": "样例看板",
+            "bdNote": null,
+            "bdConfiguration": "[{\"code\":\"709\",\"chartCode\":\"709\",\"name\":\"毛利润组成分析（按物料）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"17\",\"dataSourceName\":\"销售报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"bar\",\"layout\":{\"x\":0,\"y\":0,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"712\",\"chartCode\":\"712\",\"name\":\"呆滞库存分析（饼状图）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"pie\",\"layout\":{\"x\":0,\"y\":6,\"w\":12,\"h\":15,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null},{\"code\":\"710\",\"chartCode\":\"710\",\"name\":\"呆滞库存分析（单笔记录）\",\"creatorCode\":\"16\",\"creatorName\":\"祝通鸿\",\"dataSourceCode\":\"14\",\"dataSourceName\":\"库存报表（分销类公司）\",\"viewType\":\"chart\",\"chartType\":\"dataView\",\"layout\":{\"x\":0,\"y\":21,\"w\":12,\"h\":6,\"minW\":2,\"maxW\":12,\"minH\":1},\"fetching\":false,\"chartOption\":null}]",
+            "thumbnail": "",
+            "createBy": "祝通鸿",
+            "createId": 16,
+            "relationColumns": "[]",
+            "createDate": "2018-09-29 17:16:23.0",
+            "updateDate": null,
+            "reDate": null
+        }
+    }
+}
+```
+##### 详细说明
+___
+##  新增看板
+##### 请求路径
+`/inputDashboards`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| bdName | String | 看板标题 |
+| bdConfiguration | String | 看板内容 |
+| thumbnail | String | 缩略图 |
+| relationColumns | String | 关联列设置 |
+##### 请求示例
+```json
+{
+    "bdName": "无标题",
+    "bdNote": "",
+    "bdConfiguration": "[]",
+    "thumbnail": "",
+    "relationColumns": "[]"
+}
+```
+##### 返回结果
+##### 详细说明
+___
+##  删除看板
+##### 请求路径
+`/delDashboards`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+[看板id]
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+##### 详细说明
+___
+##  更新看板
+##### 请求路径 
+`/updateDashboards`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| id | Number | 看板id |
+| bdName | String | 看板标题 |
+| bdConfiguration | String | 看板内容 |
+| thumbnail | String | 缩略图 |
+| relationColumns | String | 关联列设置 |
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  看板分发
+##### 请求路径
+`/addObject`
+##### 请求方式
+`HTTP - POST`
+
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+##### 请求示例
+```json
+```
+##### 返回结果
+##### 详细说明
+___
+##  看板移交
+- 参照数据源分组接口说明
+##### 请求路径
+`/changeDashOrder`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+##### 请求示例
+```json
+```
+##### 返回结果
+##### 详细说明
+___

gitbook/dev/interface-dataConnect.md

@@ -1,23 +1,21 @@
 # 接口设计 - 数据连接
 ## 新增数据连接配置
 ##### 请求路径
-`/inputDatabases`
+`/DataBase/inputDatabases`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataConnect/remoteAdd')`
 ###### 请求参数
 
-|    字段名（后端）    |    字段名（前端）       |    说明          |
-|----------------------|-------------------------|------------------|
-|    name              |     model.name         |    数据连接名    |
-|    addrass           |     model.address      |    数据库地址    |
-|    port              |     model.port         |    数据库端口    |
-|    databaseType      |     model.dbType       |    数据库类型    |
-|    dataName          |     model.dbName       |    数据库名      |
-|    userName          |    model.userName      |    用户名        |
-|    passWord          |    model.password      |    密码          |
-|    note              |    model.description    |    说明          |
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| name | String | 数据连接名 |
+| addrass | String | 数据库地址 |
+| port | String | 数据库端口 |
+| databaseType | String | 数据库类型 |
+| dataName | String | 数据库名 |
+| userName | String | 用户名 |
+| passWord | String | 密码 |
+| note | String | 说明 |
 
 ##### 请求示例
 ```json
@@ -44,14 +42,21 @@
 ___
 ## 修改数据连接配置
 ##### 请求路径
-`/updatabases`
+`/DataBase/updatabases`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataConnect/remoteModify')`
 ##### 请求参数
-id : code  
-其余与新增数据连接配置相同
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| id | Number | 数据连接id |
+| name | String | 数据连接名 |
+| addrass | String | 数据库地址 |
+| port | String | 数据库端口 |
+| databaseType | String | 数据库类型 |
+| dataName | String | 数据库名 |
+| userName | String | 用户名 |
+| passWord | String | 密码 |
+| note | String | 说明 |
 
 ##### 请求示例
 ```json
@@ -79,14 +84,11 @@ id : code
 ___
 ## 删除数据连接配置
 ##### 请求路径
-`/delDatabases`
+`/DataBase/delDatabases`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataConnect/remoteDelete')`
 ##### 请求参数
-id : code  
-
+数据连接id
 ##### 请求示例
 ```json
 83
@@ -103,11 +105,9 @@ id : code
 ___
 ## 获得数据连接列表
 ##### 请求路径
-`/getDatabases`
+`/DataBase/getDatabases`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataConnect/fetchList')`
 ##### 请求参数
 空
 ##### 返回结果
@@ -162,22 +162,20 @@ ___
 ___
 ## 校验数据库连接是否合法
 ##### 请求路径
-`/testConnect`
+`/DataBase/testConnect`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataConnect/remoteValidate')`
 ##### 请求参数
 
-|    字段名（后端）    	|    字段名（前端）     	|    说明          	|
-|----------------------	|-----------------------	|------------------	|
-|    name              	|     model.name       	|    数据连接名    	|
-|    addrass           	|     model.address    	|    数据库地址    	|
-|    port              	|     model.port       	|    数据库端口    	|
-|    databaseType      	|     model.dbType     	|    数据库类型    	|
-|    dataName          	|     model.dbName     	|    数据库名      	|
-|    userName          	|    model.userName    	|    用户名        	|
-|    passWord          	|    model.password    	|    密码          	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| name | String | 数据连接名 |
+| addrass | String | 数据库地址 |
+| port | String | 数据库端口 |
+| databaseType | String | 数据库类型 |
+| dataName | String | 数据库名 |
+| userName | String | 用户名 |
+| passWord | String | 密码 |
 
 ##### 请求示例
 ```json
@@ -200,14 +198,6 @@ ___
     "data": null
 }
 ```
-测试不通过，后台直接报错了
-```json
-{
-    "err": {
-        "response": {}
-    }
-}
-```
 ##### 详细说明
 
 

gitbook/dev/interface-dataSource-policy.md

@@ -0,0 +1,177 @@
+# 接口设计 - 数据源策略
+## 获得数据源的策略
+##### 请求路径
+`/getDbStrategys`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+数据源id
+##### 请求示例
+21
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "strategies": {
+                "id": 181,
+                "tarId": 21,
+                "name": "新策略",
+                "rule": null,
+                "ruleStr": "[]",
+                "isOpen": "1",
+                "createBy": null,
+                "createDate": "2018-09-29T15:41:02.000+0000",
+                "updataDate": "2018-09-29T15:41:12.000+0000"
+            },
+            "userGroupName": [],
+            "userName": [{
+                "id": 21,
+                "name": "李嘉"
+            }]
+        }]
+    }
+}
+```
+___
+
+## 添加策略
+##### 请求路径
+`/addStrategys`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| type | enum : [ "base", "file" ] | 类型 |
+| tarId | String | 数据源id |
+| name | String | 策略名 |
+| rule | Array | 策略规则 |
+| isOpen | Number | 是否启用 |
+##### 请求示例
+```json
+{
+    "type": "base",
+    "tarId": "21",
+    "name": "新策略",
+    "rule": [],
+    "isOpen": "0"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": 191
+    }
+}
+```
+___
+
+## 修改策略
+##### 请求路径
+`/updateStrategys`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| id | Number | 策略id |
+| type | enum : [ "base", "file" ] | 类型 |
+| tarId | Number | 数据源id |
+| name | String | 策略名 |
+| rule | Array | 策略规则 |
+| isOpen | Number | 是否启用 |
+##### 请求示例
+```json
+{
+    "id": 181,
+    "type": "base",
+    "tarId": "21",
+    "name": "新策略",
+    "rule": [{
+        "columnName": "CR_RATE",
+        "columnLabel": "汇率",
+        "columnType": "scale",
+        "symbol": ">",
+        "symbolLabel": "大于",
+        "value": "0"
+    }],
+    "isOpen": "1"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 删除策略
+##### 请求路径
+`/delDbStrategys`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+[策略id]
+##### 请求示例
+```
+[191]
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 设置策略对象
+##### 请求路径
+`/addObject`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| stId | Number | 策略id |
+| type | enum : [ "base", "file" ] | 类型 |
+| obj | Array : [{ obId: 对象（用户组、用户）id, objectType: 1-用户/0-用户组 }] | 对象数组 |
+##### 请求示例
+```
+{
+    "stId": "181",
+    "type": "base",
+    "obj": [{
+        "obId": "21",
+        "objectType": "1"
+    }, {
+        "obId": "31",
+        "objectType": "1"
+    }]
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___

gitbook/dev/interface-dataSource.md

@@ -1,28 +1,19 @@
 # 接口设计 - 数据源
 ## 新增数据源
 ##### 请求路径
-`/inputDataConnector`
+`/Connector/inputDataConnector`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteAdd')`
 ##### 请求参数
-
-| 字段名（后端） 	| 字段名（前端）     	| 说明            	|
-|----------------	|--------------------	|-----------------	|
-| dataName       	| model.name        	| 数据源名称      	|
-| note           	| model.description 	| 数据源说明      	|
-| loadObject     	| model.target      	| 数据对象        	|
-| dataTag        	| model.tags        	| 标签            	|
-| type           	| model.type        	| 类型            	|
-| createBy       	|                    	| 创建者          	|
-| dbConfig       	|                    	| 数据库设置      	|
-| addrass        	| model.address     	| 数据库地址      	|
-| port           	| model.port        	| 数据库          	|
-| databaseType   	| model.dbType      	| 数据库类型      	|
-| dataName       	| model.dbName      	| 数据库名（SID） 	|
-| userName       	| model.userName    	| 用户名          	|
-| passWord       	| model.password     	| 密码            	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| dataName | String | 数据源名称 |
+| note | String | 数据源说明 |
+| loadObject | String | 数据对象[sql] |
+| type | enum : ["dataBase", "file"] | 类型 |
+| dbConfig | Object | 数据库设置 |
+| columnConfig | Array | 列数据 |
+| connectorGroup | Number | 所属分组id |
 
 ##### 请求示例
 ```json
@@ -33,6 +24,7 @@
     "type": "database",
     "createBy": "admin",
     "dbConfig": {
+        "id": "22",
         "addrass": "192.168.253.6",
         "port": "1521",
         "databaseType": "oracle",
@@ -85,39 +77,20 @@
 ___
 ## 修改数据源
 ##### 请求路径
-`/updateData`
+`/Connector/updateData`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteModify')`
 ##### 请求参数
-
-| 字段名（后端） 	| 字段名（前端）     	| 说明                       	|
-|----------------	|--------------------	|----------------------------	|
-| dataId         	| code              	| 数据源ID                   	|
-| dataName       	| model.name        	| 数据源名称                 	|
-| note           	| model.description 	| 数据源说明                 	|
-| loadObject     	| model.target      	| 数据对象                   	|
-| dataTag        	| model.tags        	| 数据源标签                 	|
-| type           	| model.type        	| 数据源类型                 	|
-| createBy       	|                    	| 创建人                     	|
-| dbConfig{      	|                    	| 数据库配置（为空时不修改）      |
-| addrass        	| model.address     	| 数据库地址                 	|
-| port           	| model.port        	| 数据库端口                 	|
-| databaseType   	| model.dbType      	| 数据库类型                 	|
-| dataName       	| model.dbName      	| 数据库名                   	|
-| userName       	| model.userName    	| 用户名                     	|
-| passWord       	| model.password     	| 密码                       	|
-| columnConfig   	|                    	| 列配置                     	|
-| columnName     	| c.name            	| 列名                       	|
-| columnLable    	| c.alias           	| 别名                       	|
-| dataType       	| c.dataType        	| 数据类型                   	|
-| columnType     	| c.columnType      	| 分析类型                   	|
-| isGroup        	| c.groupable        	| 可分组                     	|
-| isSubsection   	| c.bucketizable     	| 可分段                     	|
-| isOpen         	| c.using            	| 启用                       	|
-| remarks       	| c.description      	| 备注                       	|
-| connectorGroup 	| model.groupCode    	| 分组代码                   	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| dataId | Number | 数据源ID |
+| dataName | String | 数据源名称 |
+| note | String | 数据源说明 |
+| loadObject | String | 数据对象[sql] |
+| type | enum : ["dataBase", "file"] | 类型 |
+| dbConfig | Object | 数据库设置 |
+| columnConfig | Array | 列数据 |
+| connectorGroup | Number | 所属分组id |
 
 ##### 请求示例
 ```json
@@ -126,11 +99,11 @@ ___
     "dataName": "文档测试1",
     "note": "这个应该可以为空",
     "loadObject": "select * from bench",
-    "dataTag": null,
     "type": "database",
     "createBy": "admin",
     "connectorGroup": "-1",
     "dbConfig": {
+        "id": "11",
         "addrass": "192.168.253.6",
         "port": "1521",
         "databaseType": "oracle",
@@ -182,13 +155,11 @@ ___
 ___
 ## 删除数据源
 ##### 请求路径
-`/delDataConnector`
+`/Connector/delDataConnector`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteDelete')`
 ##### 请求参数
-code 数据源ID
+[ 数据源ID ]
 
 ##### 请求示例
 ```json
@@ -197,24 +168,22 @@ code 数据源ID
 ##### 返回结果
 ```json
 {
-    "code": -130,
-    "msg": "图表正在使用",
-    "data": []
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
 }
 ```
 ##### 详细说明
 ___
 ## 获取数据源列表
 ##### 请求路径
-`/getListDataConnector`
+`/Connector/getListDataConnector`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/fetchList')`
 ##### 请求参数
-
 无 
-
 ##### 请求示例
 ##### 返回结果
 ```json
@@ -301,11 +270,9 @@ ___
 ___
 ## 获得单个数据源详细数据
 ##### 请求路径
-`/getDataConnector`
+`/Connector/getDataConnector`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteDetail')`
 ##### 请求参数
 
 code  
@@ -341,20 +308,20 @@ code
 ___
 ## 根据sql请求列数据信息
 ##### 请求路径
-`/implementSql`
+`/Connector/implementSql`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/importNewModelColumns')`
 ##### 请求参数
-
-baseName: dataSource.newOne.userName
-strSql 
-
+```json
+{
+    "id": "数据连接id",
+    "strSql": "请求列的sql"
+}
+```
 ##### 请求示例
 ```json
 {
-	"baseName": "UAS",
+	"id": "23",
 	"strSql": "select * from Bench"
 }
 ```
@@ -366,62 +333,111 @@ strSql
     "data": [
         {
             "columnName": "BC_CODE",
-            "columnType": "VARCHAR2",
-            "remarks": "编号"
+            "columnType": "String",
         },
         {
             "columnName": "BC_DESC",
-            "columnType": "VARCHAR2",
-            "remarks": "工作台说明"
+            "columnType": "String",
         },
         {
             "columnName": "BC_DETNO",
-            "columnType": "NUMBER",
-            "remarks": "序号"
+            "columnType": "BigDecimal",
         },
         {
             "columnName": "BC_ICON",
-            "columnType": "VARCHAR2",
-            "remarks": "图标"
+            "columnType": "String",
         },
         {
             "columnName": "BC_ID",
-            "columnType": "NUMBER",
-            "remarks": "ID"
+            "columnType": "BigDecimal",
         },
         {
             "columnName": "BC_TITLE",
-            "columnType": "VARCHAR2",
-            "remarks": "工作台标题"
+            "columnType": "String",
         },
         {
             "columnName": "BC_URLCOND",
-            "columnType": "VARCHAR2",
-            "remarks": "链接条件"
+            "columnType": "String",
         },
         {
             "columnName": "BC_USED",
-            "columnType": "NUMBER",
-            "remarks": "是否使用"
+            "columnType": "BigDecimal",
+        }
+    ]
+}
+```
+___
+
+## 获得数据源下的列
+##### 请求路径
+`/DataBase/getColumnData`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+数据源id
+##### 请求示例
+23
+##### 返回结果
+```json
+{
+    "code": 200,
+    "msg": "成功",
+    "data": [
+        {
+            "columnName": "BC_CODE",
+            "columnRaname": "BC_CODE",
+            "columnType": "String",
+            "isGroup": "1",
+            "isFilter": "1",
+            "isSubsection": "1"
+        }
+    ]
+}
+```
+___
+
+## 数据源移交
+##### 请求路径
+`/Connector/changeDbOrder`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| userId | Number | 用户id |
+| id | Number | 数据源id |
+##### 请求示例
+```json
+{
+    "userId": "23",
+    "id": "157"
+}
+```
+##### 返回结果
+```json
+{
+    "code": 200,
+    "msg": "成功",
+    "data": [
+        {
+            "columnName": "BC_CODE",
+            "columnRaname": "BC_CODE",
+            "columnType": "String",
+            "isGroup": "1",
+            "isFilter": "1",
+            "isSubsection": "1"
         }
     ]
 }
 ```
-##### 详细说明
-此处业务逻辑需要调整为以下两种情况：
-1.根据sql取出实际的列数据，不限于单表，可能只取部分列。
-2.支持表名、列定义的方式获得列数据（类似数据观）
 ___
 ## 获得数据源所有分组/子分组
 ##### 请求路径
-`/getConnectorGroup`
+`/Connector/getConnectorGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteGroupList')`
 ##### 请求参数
 无
-
 ##### 请求示例
 ```json
 null
@@ -512,27 +528,23 @@ null
 ___
 ## 新增数据源分组/子分组
 ##### 请求路径
-`/setConnectorGroup`
+`/Connector/setConnectorGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/ remoteAddGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| fatherId | Number | 父级分组ID |
+| groupName | String| 组名 |
+| groupIndex | Number | 顺序号 |
 
 ##### 请求示例
 ```json
 {
     "fatherId": "-1",
     "groupName": "新分组",
-    "groupIndex": 2,
-    "createBy": "zhuth"
+    "groupIndex": 2
 }
 ```
 ##### 返回结果
@@ -551,20 +563,17 @@ ___
 ___
 ## 修改数据源分组信息
 ##### 请求路径
-`/updataDataConnectorGroup`
+`/Connector/updataDataConnectorGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteModifyGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| Id             	| Group.code     	| 分组ID            	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
+| 字段名 | 类型 | 说明 |
+|--- | --- | --- |
+| Id | Number | 分组ID |
+| fatherId | Number | 父级分组ID |
+| groupName | String | 组名 |
+| groupIndex | Number | 顺序号 |
 
 ##### 请求示例
 ```json
@@ -573,7 +582,6 @@ ___
     "fatherId": "1",
     "groupName": "默认子分组11",
     "groupIndex": 0,
-    "createBy": "zhuth"
 }
 ```
 ##### 返回结果
@@ -590,17 +598,15 @@ ___
 ___
 ## 设置数据源所属分组
 ##### 请求路径
-`/updateConnectConfigGroup`
+`/Connector/updateConnectConfigGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteSetDataSourceGroup')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明       	|
-|----------------	|----------------	|------------	|
-| Id             	| DatasourceCode 	| 数据源ID   	|
-| GroupID        	| “新子分组”'    	| 目标分组ID 	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| Id | Number | 数据源ID |
+| GroupID | Number | 目标分组ID |
 
 ##### 请求示例
 ```json
@@ -623,19 +629,16 @@ ___
 ___
 ## 批量修改数据源分组信息
 ##### 请求路径
-`/updataConnectorGroup`
+`/Connector/updataConnectorGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteModifyGroups')`
 ##### 请求参数
 
-| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
-|----------------	|----------------	|-------------------	|
-| fatherId       	| pgroup.code    	| 父级分组ID        	|
-| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
-| groupIndex     	|                	| 分组索引          	|
-| createBy       	|                	| 创建人            	|
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| fatherId | Number | 父级分组ID |
+| groupName | String | 组名 |
+| groupIndex | Number | 顺序号 |
 
 ##### 请求示例
 ```json
@@ -670,18 +673,12 @@ ___
 }
 ```
 ##### 详细说明
-批量修改现在主要用于移动分组位置的改动，前台计算移动位置可能造成改动的分组节点生成一个数组返回到后台统一更新。
-此处将整个groups集体上传 集体替换。
-此处建议使用batch表达批量修改的概念。
-
 ___
 ## 删除数据源分组/子分组
 ##### 请求路径
-`/delDataConnectorGroup`
+`/Connector/delDataConnectorGroup`
 ##### 请求方式
 `HTTP - POST`
-##### 包类方法
-`dispatch(type:'dataSource/remoteDeleteGroup'')`
 ##### 请求参数
 
 group.code 分组ID

gitbook/dev/interface-user.md

@@ -0,0 +1,291 @@
+# 接口设计 - 用户
+## 登录
+系统登录需要UAS账号（手机号和密码）验证
+##### 请求路径
+`/login`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```json
+{
+    "userName": "手机号",
+    "passWord": "密码"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code":200,
+        "msg":"成功",
+        "data": {
+            "token": "...",
+            "times": "1538971981364",
+            "user": {
+                "id":31,
+                "name": "张三",
+                "userName":"17600000000",
+                "passWord":"11111111",
+                "department":"销售经理",
+                "post":"国内销售科",
+                "role":null,
+                "phone":"17600000000",
+                "createDate":null,
+                "updateDate":null
+            }
+        }
+    }
+}
+```
+___
+
+## 获取用户列表
+##### 请求路径
+`/getUserList`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+无
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "id": 16,
+            "name": "张三",
+            "userName": "17600000000",
+            "passWord": "111111",
+            "department": "销售经理",
+            "post": "国内销售科",
+            "role": "admin",
+            "phone": null,
+            "createDate": "2018-09-28T18:29:11.000+0000",
+            "updateDate": null
+        }, {
+            "id": 22,
+            "name": "李四",
+            "userName": "18100000000",
+            "passWord": "111111",
+            "department": "采购跟单科科长",
+            "post": "采购部",
+            "role": null,
+            "phone": null,
+            "createDate": "2018-09-29T10:24:26.000+0000",
+            "updateDate": null
+        }]
+    }
+}
+```
+___
+
+## 获得用户组列表
+##### 请求路径
+`/getUserGroupList`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+无
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "id": 43,
+            "userGroupName": "BI项目组",
+            "userGroupNote": "BI项目组",
+            "createDate": "2018-09-06T14:03:02.000+0000",
+            "updateDate": "2018-09-29T17:44:24.000+0000"
+        }]
+    }
+}
+```
+___
+
+## 添加用户组
+##### 请求路径
+`/createUserGroup`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```json
+{
+    "userGroupName": "组名",
+    "userGroupNote": "备注"
+}
+```
+##### 返回结果
+
+___
+
+## 删除用户组
+##### 请求路径
+`/delUserGroup`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```
+[id: 用户组id]
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 修改用户组
+##### 请求路径
+`/updateUserGroup`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```json
+{
+    "id": "用户组id",
+    "userGroupName": "新用户组名",
+    "userGroupNote": "新备注"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 获得用户组成员列表
+##### 请求路径
+`/getUserInGroup`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```
+用户组id
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "id": 16,
+            "name": "祝通鸿",
+            "userName": null,
+            "passWord": null,
+            "department": "销售经理",
+            "post": "国内销售科",
+            "role": "admin",
+            "phone": null,
+            "createDate": null,
+            "updateDate": null
+        }, {
+            "id": 22,
+            "name": "陈文俊",
+            "userName": null,
+            "passWord": null,
+            "department": "采购跟单科科长",
+            "post": "采购部",
+            "role": null,
+            "phone": null,
+            "createDate": null,
+            "updateDate": null
+        }]
+    }
+}
+```
+___
+
+## 添加用户组成员
+##### 请求路径
+`/setUserInto`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```json
+{
+    "userList": ["用户id"],
+    "userGroupId": "用户组id"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 删除用户组成员
+##### 请求路径
+`/delUserInGroup`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```json
+{
+    "userList": ["用户id"],
+    "userGroupId": "用户组id"
+}
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
+___
+
+## 关键字查询用户
+##### 请求路径
+`/getNameList`
+##### 请求方式
+`HTTP - POST`
+##### 请求参数
+```
+关键字
+```
+##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "id": 16,
+            "name": "祝通鸿",
+            "userName": null,
+            "passWord": null,
+            "department": "销售经理",
+            "post": "国内销售科",
+            "role": "admin",
+            "phone": null,
+            "createDate": null,
+            "updateDate": null
+        }]
+    }
+}
+```
+___