部署gitbook-dev 修改jenkinsfile与dockerfile使其自动化构建

.gitignore

@@ -4,4 +4,6 @@ node_modules
 *.css
 .scannerwork/.sonar_lock
 .scannerwork/report-task.txt
-src/demo.jsx
+src/demo.jsx
+gitbook/dev/_book
+gitbook/dev/node_modules

Dockerfile

@@ -16,6 +16,7 @@ RUN rm sonarscanner.zip
 ENV SONAR_RUNNER_HOME=/sonar-scanner-3.2.0.1227-linux
 ENV PATH $PATH:/sonar-scanner-3.2.0.1227-linux/bin
 COPY sonar-runner.properties ./sonar-scanner-3.2.0.1227-linux/conf/sonar-scanner.properties
-RUN npm install -g cnpm --registry=https://registry.npm.taobao.org
+RUN npm install cnpm -g --registry=https://registry.npm.taobao.org
+RUN npm install gitbook-cli -g 
 ADD default /etc/nginx/sites-available
 EXPOSE 80

Jenkinsfile

@@ -12,6 +12,16 @@ pipeline {
                 sh 'sonar-scanner'
             }
         }
+        stage('Build Dev Gitbook') {
+            steps {
+                sh 'gitbook build ./gitbook/dev'
+            }
+        }
+        stage('Build Product Gitbook') {
+            steps {
+                sh 'gitbook build ./gitbook/product'
+            }
+        }
 
         stage('Install') {
             steps {

gitbook/dev/README.md

@@ -0,0 +1,14 @@
+![Logo](asset/image/UAS_Logo.png)
+
+# BI商业智能平台 - 研发设计文档
+
+##### 编写人
+`肖春腾`
+##### 编写日期
+`2018/07/31`
+
+| 文档版本号 	| 文档密级  	| 项目编号 	| 归属部门/项目 	|
+|------------	|-----------	|----------	|---------------	|
+| V1.0       	| 机密文件  	|          	|               	|
+
+##### 深圳市优软科技有限公司 版权所有 内部资料 注意保密

gitbook/dev/SUMMARY.md

@@ -0,0 +1,18 @@
+# Summary
+* [首页](README.md)
+
+* [引言](intro.md)
+    * 项目背景
+    * 人员准备
+* [业务流程图](workflow.md)
+* [数据库设计](database.md)
+* [模块设计](modules.md)
+* 接口设计
+    * [数据连接](interface-dataConnect.md)
+    * [数据源](interface-dataSource.md)
+    * [图表](interface-chart.md)
+    * 看板(第二期) 
+* [附录](appendix.md)
+    * [前端框架结构](appendix.md#前端框架结构)
+
+

gitbook/dev/appendix.md

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

gitbook/dev/book.json

@@ -0,0 +1,5 @@
+{
+    "plugins": [
+        "yahei"
+    ] 
+}

gitbook/dev/database.md

@@ -0,0 +1,209 @@
+# 数据库设计
+### 数据源表bi_data_connectors
+
+| 字段名称      | 类型   | 备注       | 样例数据            |
+|---------------|--------|------------|---------------------|
+| id            | int    | 唯一标识   | 109                 |
+| data_name     | vachar | 名称       | 销售统计            |
+| data_note     | vachar | 数据源描述 |                     |
+|DATA_TAG|vachar|标签|
+| LOAD_OBJECT | vachar | 配置信息   | select * from…      |
+| columns_config        | vachar| 自定义列属性      |    json             |
+|data_type| vachar|数据源类型| 物料|
+| created_by    | vachar | 创建人     | 特朗普              |
+|used_number|int|使用数量|60|
+|DB_CONFIG|vachar|数据库配置|
+|TABLE_NAME|vachar|表名|
+|con_type|vachar|数据源类型|
+|BD_DATA_ID|int|数据连接ID|
+|BD_GROUP|int|数据源分组ID|
+| create_date   | vachar | 创建时间   | 1999-11-11 12:18:30 |
+| update_date   | vachar | 更新时间   | 1999-11-11 12:18:30|
+Id为主键，与bi_charts的data_id对应。
+
+json样例:  
+```json
+columns_config:
+[{    
+"columnName" : "p_name"，  
+"columnLable" : "名称"，  
+"columnType" : "categorical "        //列的数据类别
+},  
+{  
+"columnName" : "updata_time"，
+"columnLable" : "更新时间"，  
+"columnType" : "time"   
+}]
+
+```
+___
+
+### 报告与看板表bi_dashboards
+
+| 字段名称    | 类型   | 备注     | 样例数据            |
+|-------------|--------|----------|---------------------|
+| id          | int    | 唯一标识 | 110                 |
+| bd_name | varchar | 看板名称 |                     |
+|bd_note | varchar | 看板描述 |                     |
+| configuration| vachar| 看板布局配置|json
+| created_by  | varchar | 创建人   | 赵日天              |
+| create_time | varchar | 创建时间 | 1999-11-11 12:18:30 |
+| update_time | varchar | 更新时间 |                     |
+Id为主键，与bi_chart_config的dashboard _id对应。  
+json样例：  
+```json
+configuration:
+[{    
+"chartId" : "1"，  
+"xCoord" : "123"，
+"yCoord" : "321",
+"width" : "100px",
+"height" : "50px"
+},  
+{  
+"chartId" : "2"，  
+"xCoord" : "100"，
+"yCoord" : "100",
+"width" : "300px",
+"height" : "100px" 
+}]
+```
+
+___
+### 视图表bi_charts
+| 字段名称     | 类型   | 备注     | 样例数据            |
+|--------------|--------|----------|---------------------|
+| id           | int    | 唯一标识 | 120                 |
+| chart_name   | varchar | 视图名称 | 数据统计            |
+| chart_type   | varchar | 视图类型 | pie                 |
+| BD_DATA_ID    | int    | 数据源id | 9527                |
+| created_by    | varchar | 创建人   | 李狗蛋              |
+|GROUP_BY | varchar|分组|职位|
+|ACCESS_AUTHORITY | varchar|访问权限|创建人|
+|UPDATE_AUTHORITY| varchar|修改权限|某某某|
+|CHART_DESCRIBES | varchar|描述|一大串东西|
+|BC_CHART_STYLE | vachar|样式|默认开启|
+| chart_config | varchar | 配置信息 | json                |
+|BC_FILTERS|varchart|筛选|
+|BC_CHARTS_GROUP|int|分组ID|
+| create_date  | vachar | 创建时间 | 1999-11-11 12:18:30 |
+| update_date  | vachar | 更新时间 |                     |
+id为主键，data_id关联bi_data_connectors表id；dashboard_id关联bi_dashboard表id。  
+json样例：  
+```json
+ chart_config:
+{
+"subsection":[                //分组
+    	{
+    	  "colunmName":"名称",
+          "colunmType":"字符串",
+          "character":"包含",          //运算符号
+          "value":"刘",                        //运算值
+          "sectionFate":"3"              //平均分成多少组
+    	},
+    	{
+    	  "colunmName":"更新时间",
+          "colunmType":"标量",
+          "character":">",
+          "value":"06:00",
+          "sectionFate":"4" 
+    	}
+    ],
+"group":                    //分组
+    	[{
+          "colunmName":"名称",
+          "colunmType":"字符串",
+          "character":"包含",
+          "value":"刘",
+          "sectionFate":"3" 
+    	},
+    	{
+    	  "colunmName":"更新时间",
+          "colunmType":"标量",
+          "character":">",
+          "value":"06:00",
+          "sectionFate":"4" 
+    	}
+    ],
+"showLines" : "100",
+"count" : [{                                   //计数
+          "colunmName":"名称",
+          "colunmType":"",
+          "character":"",
+          "value":"",
+          "sectionFate":"" 
+    	},
+{
+          "colunmName":"名称",
+          "colunmType":"",
+          "character":"",
+          "value":"",
+          "sectionFate":"" 
+    	}
+],
+"accumulate" : [{                             //累积
+          "colunmName":"名称",
+          "colunmType":"",
+          "character":"",
+          "value":"",
+          "sectionFate":"" 
+    	},
+{
+          "colunmName":"名称",
+          "colunmType":"",
+          "character":"",
+          "value":"",
+          "sectionFate":"" 
+    	}
+],
+"bar" : [{                               //扇形索引
+          "colunmName":"名称",
+          "colunmType":"",
+          "character":"",
+          "value":"",
+          "sectionFate":"" 
+}]，
+"childChart" : [                           
+{                                                                          //第一层子表配置
+          "childName":"个人统计",
+          "chartType":"pie",
+          "config" : "格式同父亲视图"
+} ,
+{                                                                       //第二层子表配置
+          "childName":"个人单月统计",
+          "chartType":"line",
+          "config" : "格式同父亲视图"
+} ]
+}
+```
+
+___
+### 数据连接表BI_DATABASES
+
+| 字段名称     | 类型   | 备注     | 样例数据            |
+|--------------|--------|----------|---------------------|
+|ID|int| ID| 123|
+|BASES_NAME|vachar|数据库连接名|
+|ADDRASS|vachart|地址|
+|port|vachart|端口|
+|DATABASE_TYPE|vachart|类型|
+|DATA_NAME|vachar|数据库名称|
+|user_name|vachar|用户名|
+|PASS_WORD|vachar|密码|
+|CREATE_DATE|date|
+|UPDATE_DATE|date|
+|NOTE|vachart|说明|
+id为主键，关联数据源表
+___
+### 数据源分组表BI_BASE_GROUP_BY&&图表分组BI_CHARTS_GROUP
+
+| 字段名称     | 类型   | 备注     | 样例数据            |
+|--------------|--------|----------|---------------------|
+|BC_ID|int|id|
+|BC_GROUP_NAME|vachar|分组名称|
+|BC_INDEX|vachar|分组下标|
+|BC_FATHER_ID|int|父组ID|
+|CREATE_BY|vachar|创建人|
+|CREATE_DATE|date|创建时间|
+|UPDATA_DATE|date|更新时间|
+bc_id为主键，关联图表

gitbook/dev/interface-chart.md

@@ -0,0 +1,256 @@
+# 数据接口 - 图表
+##  新增图表
+##### 请求路径: 
+`/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    	|                             	| 图表配置          	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+根据base.viewType的不同  chartConfig加载内容也不同
+___
+##  修改图表
+##### 请求路径
+`/updateCharts`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteModify')`
+##### 请求参数
+
+ChartID: code （图表编号） 其余同新增图表
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  删除图表
+##### 请求路径
+`/delChartsConfig`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteDelete')`
+##### 请求参数
+
+Code （图表编号）  
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  获得图表列表
+##### 请求路径
+`/getListCharts`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/fetchList')`
+##### 请求参数
+
+空
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  获得单个图表详细数据
+##### 请求路径 
+`/getChartsConfig`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteDetail')`
+##### 请求参数
+
+Code (图表编号)
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  请求单个图表展示数据
+##### 请求路径
+`/showHistogram`
+`/showPie`
+`/showLine`
+`/showScatter`
+`/showIndividual`
+
+##### 请求方式
+`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轴统计方式 	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+此处gauge的命名可能会容易混淆：指的对单列进行合计统计的方式，分有计数、累计、最大值、中位数、平均值、最小值等。可能混淆的名称有metrics, aggregate等。
+___
+##  获得图表所有分组/子分组
+##### 请求路径
+`/getChartsGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteGroupList')`
+##### 请求参数
+
+空 
+
+##### 请求示例
+##### 返回结果
+Code 分组编号
+Pcode 父级分组编号
+Index 索引
+Label 标签
+##### 详细说明
+___
+##  新增图表分组/子分组
+##### 请求路径 
+`/setChartsGroup`
+#####请求方式`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteAddGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+如果是顶级分组（没有父级分组），则父级分组ID设置为-1
+___
+##  修改图表分组信息
+##### 请求路径 
+`/updataChartsGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteModifyGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| Id             	| Group.code     	| 分组ID            	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  设置图表所属分组
+##### 请求路径 
+`/updateChartConfigGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteSetChartGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明       	|
+|----------------	|----------------	|------------	|
+| Id             	| DatasourceCode 	| 数据源ID   	|
+| GroupID        	| “新子分组”’    	| 目标分组ID 	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  批量修改图表分组信息
+##### 请求路径 
+`/updataListGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteModifyGroups')`
+##### 请求参数
+
+id : code  
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+##  删除图表分组/子分组
+##### 请求路径 
+`/delChartsGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chart/remoteDeleteGroup')`
+##### 请求参数
+
+Code ID
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 图表编辑器
+##  获得数据源下的列数据
+##### 请求路径 
+`/getColumnData`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'chartDesigner/remoteDataColumn')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”’    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+此处将整个groups集体上传 集体替换。
+此处建议使用batch表达批量修改的概念。

gitbook/dev/interface-dataConnect.md

@@ -0,0 +1,94 @@
+# 接口设计 - 数据连接
+## 新增数据连接配置
+##### 请求路径
+`/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    |    说明          |
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 修改数据连接配置
+##### 请求路径
+`/updatabases`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataConnect/remoteModify')`
+##### 请求参数
+id : code  
+其余与新增数据连接配置相同
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 删除数据连接配置
+##### 请求路径
+`/delDatabases`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataConnect/remoteDelete')`
+##### 请求参数
+id : code  
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 获得数据连接列表
+##### 请求路径
+`/getDatabases`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataConnect/fetchList')`
+##### 请求参数
+空
+
+##### 返回结果
+##### 详细说明
+___
+## 校验数据库连接是否合法
+##### 请求路径
+`/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    	|    密码          	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+
+
+
+
+

gitbook/dev/interface-dataSource.md

@@ -0,0 +1,250 @@
+# 接口设计 - 数据源
+## 新增数据源
+##### 请求路径
+`/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     	| 密码            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 修改数据源
+##### 请求路径
+`/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    	| 分组代码                   	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 删除数据源
+##### 请求路径
+`/delDataConnector`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteDelete')`
+##### 请求参数
+
+code 数据源ID
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 获取数据源列表
+##### 请求路径
+`/getListDataConnector`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/fetchList')`
+##### 请求参数
+
+无 
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 获得单个数据源详细数据
+##### 请求路径
+`/getDataConnector`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteDetail')`
+##### 请求参数
+
+code  
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 根据sql请求列数据信息
+##### 请求路径
+`/implementSql`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/importNewModelColumns')`
+##### 请求参数
+
+baseName: dataSource.newOne.userName
+strSql 
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+此处业务逻辑并不是很完整和清晰
+___
+## 获得数据源所有分组/子分组
+##### 请求路径
+`/getConnectorGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteGroupList')`
+##### 请求参数
+
+Code 分组编号
+Pcode 父级分组编号
+Index 索引
+Label 标签
+
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+
+___
+## 新增数据源分组/子分组
+##### 请求路径
+`/setConnectorGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/ remoteAddGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+如果是顶级分组（没有父级分组），则父级分组ID设置为-1
+
+___
+## 修改数据源分组信息
+##### 请求路径
+`/updataDataConnectorGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteModifyGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| Id             	| Group.code     	| 分组ID            	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 设置数据源所属分组
+##### 请求路径
+`/updateConnectConfigGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteSetDataSourceGroup')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明       	|
+|----------------	|----------------	|------------	|
+| Id             	| DatasourceCode 	| 数据源ID   	|
+| GroupID        	| “新子分组”'    	| 目标分组ID 	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+___
+## 批量修改数据源分组信息
+##### 请求路径
+`/updataConnectorGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteModifyGroups')`
+##### 请求参数
+
+| 字段名（后端） 	| 字段名（前端） 	| 说明              	|
+|----------------	|----------------	|-------------------	|
+| fatherId       	| pgroup.code    	| 父级分组ID        	|
+| groupName      	| “新子分组”'    	| 基础配置 – 数据源 	|
+| groupIndex     	|                	| 分组索引          	|
+| createBy       	|                	| 创建人            	|
+
+##### 请求示例
+##### 返回结果
+##### 详细说明
+此处将整个groups集体上传 集体替换。
+此处建议使用batch表达批量修改的概念。
+
+___
+## 删除数据源分组/子分组
+##### 请求路径
+`/delDataConnectorGroup`
+##### 请求方式
+`HTTP - POST`
+##### 包类方法
+`dispatch(type:'dataSource/remoteDeleteGroup'')`
+##### 请求参数
+
+group.code 分组ID
+
+##### 请求示例
+##### 返回结果
+##### 详细说明

gitbook/dev/intro.md

@@ -0,0 +1,7 @@
+## 1.1 项目背景
+- 【主要简单介绍产品/项目】
+
+
+
+## 1.2 人员准备
+姓名	角色	职责

gitbook/dev/modules.md

@@ -0,0 +1,19 @@
+# 模块设计
+- 用户模块 （未定期）
+    - “我的模块”（未定期）
+- 数据源模块（第一期目标）
+    - 数据源列表
+    - 数据源创建/配置
+    - 数据列配置
+    - 权限配置
+    - 预览数据
+- 图表模块（第一期目标）
+    - 图表列表
+    - 图表编辑器
+        - 图表配置
+        - 其他配置
+        - 撤销/重做
+- 报告与看板模块（暂定二期目标）
+    - 报告与看板列表
+    - 报告与看板编辑器
+- 建模分析模块（未定期）

gitbook/dev/workflow.md

@@ -0,0 +1,5 @@
+# 业务流程图
+
+![业务流程图 - 新增数据源](asset/image/workflow1.png)
+
+![业务流程图 - 新增图表](asset/image/workflow2.png)

gitbook/product/README.md

@@ -0,0 +1,2 @@
+# Introduction
+

gitbook/product/SUMMARY.md

@@ -0,0 +1,4 @@
+# Summary
+
+* [Introduction](README.md)
+