接口文档完善

gitbook/dev/interface-chart.md

@@ -24,7 +24,28 @@
 | chartConfig    	|                             	| 图表配置          	|
 
 ##### 请求示例
+```json
+{
+    "chartName": "文档测试1(未命名)",
+    "dataId": 71,
+    "groupBy": [],
+    "createBy": "zhuth",
+    "describes": "",
+    "style": "",
+    "chartConfig": "{}",
+    "chartType": ""
+}
+```
 ##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": 298
+    }
+}
+```
 ##### 详细说明
 根据base.viewType的不同  chartConfig加载内容也不同
 ___
@@ -40,7 +61,31 @@ ___
 ChartID: code （图表编号） 其余同新增图表
 
 ##### 请求示例
+```json
+{
+    "chartId": 298,
+    "chartName": "文档测试1(未命名)",
+    "dataId": 71,
+    "createBy": "zhuth",
+    "describes": null,
+    "style": "",
+    "otherConfig": "{}",
+    "chartsGroup": "-1",
+    "chartType": "Histogram",
+    "chartConfig": "{\"xAxis\":{\"column\":{},\"granularity\":{}},\"yAxis\":{\"column\":{},\"gauge\":{}},\"groupBy\":{\"key\":\"\"}}",
+    "groupBy": []
+}
+```
 ##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": null
+    }
+}
+```
 ##### 详细说明
 ___
 ##  删除图表
@@ -66,11 +111,89 @@ ___
 ##### 包类方法
 `dispatch(type:'chart/fetchList')`
 ##### 请求参数
-
 空
-
-##### 请求示例
 ##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": [{
+            "chartId": 262,
+            "chartName": "bbbb",
+            "chartType": "Pie",
+            "describes": null,
+            "chartsGroup": -1,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 11:17:33.0"
+        }, {
+            "chartId": 265,
+            "chartName": "销售订单0",
+            "chartType": "individual",
+            "describes": null,
+            "chartsGroup": 26,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 15:35:29.0"
+        }, {
+            "chartId": 263,
+            "chartName": "bench_flowchart(未命名)111",
+            "chartType": "Histogram",
+            "describes": null,
+            "chartsGroup": 41,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 11:18:19.0"
+        }, {
+            "chartId": 267,
+            "chartName": "销售订单(未命名)",
+            "chartType": "Line",
+            "describes": null,
+            "chartsGroup": 41,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 17:49:00.0"
+        }, {
+            "chartId": 264,
+            "chartName": "hhjhh",
+            "chartType": "Histogram",
+            "describes": null,
+            "chartsGroup": -1,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 11:20:16.0"
+        }, {
+            "chartId": 295,
+            "chartName": "bbbb_副本",
+            "chartType": "Pie",
+            "describes": null,
+            "chartsGroup": -1,
+            "createBy": "zhuth",
+            "createDate": "2018-08-08 13:56:26.0"
+        }, {
+            "chartId": 266,
+            "chartName": "销售订单1",
+            "chartType": "population",
+            "describes": null,
+            "chartsGroup": 26,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 16:22:30.0"
+        }, {
+            "chartId": 298,
+            "chartName": "文档测试1(未命名)",
+            "chartType": "Histogram",
+            "describes": null,
+            "chartsGroup": -1,
+            "createBy": "zhuth",
+            "createDate": "2018-08-08 16:32:33.0"
+        }, {
+            "chartId": 261,
+            "chartName": "bench_flowchart(未命名)",
+            "chartType": "Histogram",
+            "describes": null,
+            "chartsGroup": -1,
+            "createBy": "zhuth",
+            "createDate": "2018-08-06 10:03:03.0"
+        }]
+    }
+}
+```
 ##### 详细说明
 ___
 ##  获得单个图表详细数据
@@ -85,7 +208,37 @@ ___
 Code (图表编号)
 
 ##### 请求示例
+```json
+298
+```
 ##### 返回结果
+```json
+{
+    "data": {
+        "code": 200,
+        "msg": "成功",
+        "data": {
+            "chartId": 298,
+            "chartName": "文档测试1(未命名)",
+            "tableName": null,
+            "chartType": "Histogram",
+            "chartsGroup": -1,
+            "groupBy": "[]",
+            "chartConfig": "{\"xAxis\":{\"column\":{},\"granularity\":{}},\"yAxis\":{\"column\":{},\"gauge\":{}},\"groupBy\":{\"key\":\"\"}}",
+            "createBy": "zhuth",
+            "accessAuthority": "null",
+            "updateAuthority": "null",
+            "describes": null,
+            "style": "\"\"",
+            "filters": "null",
+            "createDate": "2018-08-08 16:32:33.0",
+            "updateDate": null,
+            "dataId": 71,
+            "subsections": null
+        }
+    }
+}
+```
 ##### 详细说明
 ___
 ##  请求单个图表展示数据
@@ -122,9 +275,12 @@ ___
 ##### 请求示例
 ##### 返回结果
 ##### 详细说明
-此处gauge的命名可能会容易混淆：指的对单列进行合计统计的方式，分有计数、累计、最大值、中位数、平均值、最小值等。可能混淆的名称有metrics, aggregate等。
+- 在不同的可视化模式下有不同的请求参数，这里不一一列出了
+- 此处gauge的命名可能会容易混淆：指的对单列进行合计统计的方式，分有计数、累计、最大值、中位数、平均值、最小值等。可能混淆的名称有metrics, aggregate等。
+- 
 ___
 ##  获得图表所有分组/子分组
+- 参照数据源分组接口说明
 ##### 请求路径
 `/getChartsGroup`
 ##### 请求方式
@@ -250,7 +406,67 @@ ___
 | createBy       	|                	| 创建人            	|
 
 ##### 请求示例
+```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"
+        }]
+    }
+}
+```
 ##### 详细说明
 此处将整个groups集体上传 集体替换。
 此处建议使用batch表达批量修改的概念。

gitbook/dev/interface-dataConnect.md

@@ -20,7 +20,26 @@
 |    note              |    model.description    |    说明          |
 
 ##### 请求示例
+```json
+{
+    "name": "test",
+    "addrass": "192.168.253.6",
+    "port": "1521",
+    "databaseType": "oracle",
+    "dataName": "orcl",
+    "userName": "UAS",
+    "passWord": "123456",
+    "note": "说明"
+}
+```
 ##### 返回结果
+```json
+{
+    "code": 200,
+    "msg": "成功",
+    "data": 83
+}
+```
 ##### 详细说明
 ___
 ## 修改数据连接配置
@@ -35,7 +54,27 @@ id : code
 其余与新增数据连接配置相同
 
 ##### 请求示例
+```json
+{
+    "id": 83,
+    "name": "test1",
+    "addrass": "192.168.253.6",
+    "port": "1521",
+    "databaseType": "oracle",
+    "dataName": "orcl",
+    "userName": "UAS",
+    "passWord": "select!#%*(",
+    "note": "说明"
+}
+```
 ##### 返回结果
+```
+{
+    "code": 200,
+    "msg": "成功",
+    "data": null
+}
+```
 ##### 详细说明
 ___
 ## 删除数据连接配置
@@ -49,7 +88,17 @@ ___
 id : code  
 
 ##### 请求示例
+```json
+83
+```
 ##### 返回结果
+```
+{
+    "code": 200,
+    "msg": "成功",
+    "data": null
+}
+```
 ##### 详细说明
 ___
 ## 获得数据连接列表
@@ -61,8 +110,54 @@ ___
 `dispatch(type:'dataConnect/fetchList')`
 ##### 请求参数
 空
-
 ##### 返回结果
+```json
+{
+    "code": 200,
+    "msg": "成功",
+    "data": [
+        {
+            "id": 62,
+            "name": "UAS标准版",
+            "addrass": "192.168.253.6",
+            "port": "1521",
+            "databaseType": "oracle",
+            "dataName": "orcl",
+            "userName": "UAS",
+            "passWord": "",
+            "note": "这个说明应该允许为空，如果是常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常文本",
+            "createDate": "2018-08-06 11:26:07.0",
+            "updateDate": null
+        },
+        {
+            "id": 55,
+            "name": "华商龙",
+            "addrass": "218.18.115.198",
+            "port": "1521",
+            "databaseType": "oracle",
+            "dataName": "orcl",
+            "userName": "N_WILIC",
+            "passWord": "",
+            "note": "华商龙",
+            "createDate": "2018-08-01 16:11:24.0",
+            "updateDate": null
+        },
+        {
+            "id": 82,
+            "name": "文档测试",
+            "addrass": "192.168.253.6",
+            "port": "1521",
+            "databaseType": "oracle",
+            "dataName": "orcl",
+            "userName": "UAS",
+            "passWord": "",
+            "note": "61",
+            "createDate": "2018-08-08 16:02:04.0",
+            "updateDate": null
+        }
+    ]
+}
+```
 ##### 详细说明
 ___
 ## 校验数据库连接是否合法
@@ -85,7 +180,34 @@ ___
 |    passWord          	|    model.password    	|    密码          	|
 
 ##### 请求示例
+```json
+{
+    "name": "文档测试",
+    "addrass": "192.168.253.6",
+    "port": "1521",
+    "databaseType": "oracle",
+    "dataName": "orcl",
+    "userName": "UAS",
+    "passWord": "123456"
+}
+```
 ##### 返回结果
+测试通过
+```json
+{
+    "code": 200,
+    "msg": "成功",
+    "data": null
+}
+```
+测试不通过，后台直接报错了
+```json
+{
+    "err": {
+        "response": {}
+    }
+}
+```
 ##### 详细说明
 
 

src/components/chartDesigner/content.less

@@ -24,4 +24,9 @@
             }
         }
     }
+    .ant-cascader-picker {
+        .anticon {
+            font-size: 12px;
+        }
+    }
 }

src/components/chartDesigner/header.jsx

@@ -28,7 +28,7 @@ class Header extends React.Component {
     }
 
     render() {
-        const { chartDesigner, dispatch } = this.props;
+        const { chartDesigner, dispatch, past, future } = this.props;
         const { newHeaderLabel } = this.state;
         return (
             <div className='header'>
@@ -89,7 +89,7 @@ class Header extends React.Component {
                 <div className='header-item toolbar-buttons'>
                     <div>
                         <Tooltip title='复制新增'>
-                            <Button shape="circle" icon='copy' onClick={() => {
+                            <Button className='tools-btn' icon='copy' onClick={() => {
                                 this.setState({
                                     visibleCopyBox: true,
                                     newHeaderLabel: chartDesigner.header.label + '_副本'
@@ -112,12 +112,12 @@ class Header extends React.Component {
                             }} />
                         </Modal>
                         <Tooltip title='撤销'>
-                            <Button shape="circle" icon='undo' onClick={() => {
+                            <Button className='tools-btn' icon='undo' disabled={past.length === 0} onClick={() => {
                                 dispatch(ActionCreators.undo());
                             }}></Button>
                         </Tooltip>
                         <Tooltip title='重做'>
-                            <Button shape="circle" icon='redo' onClick={() => {
+                            <Button className='tools-btn' icon='redo' disabled={future.length === 0} onClick={() => {
                                 dispatch(ActionCreators.redo());
                             }}></Button>
                         </Tooltip>
@@ -129,7 +129,8 @@ class Header extends React.Component {
 }
 
 function mapStateToProps(state) {
-    const chartDesigner = state.present.chartDesigner;
-    return { chartDesigner }
+    const { past, present, future } = state;
+    const chartDesigner = present.chartDesigner;
+    return { chartDesigner, past, future }
 }
 export default connect(mapStateToProps)(Header);

src/components/chartDesigner/header.less

@@ -33,6 +33,16 @@
             }
         }
     }
+    .toolbar-buttons {
+        button {
+            background: transparent;
+            border: none;
+
+            .anticon {
+                font-size: 20px;
+            }
+        }
+    }
 }
 .ant-tooltip-arrow {
     border-bottom-color: rgba(255,255,255,.75) !important;

src/components/chartDesigner/sections/barConfigForm.jsx

@@ -10,7 +10,6 @@ const BarConfigForm = ({ chartDesigner, dispatch, formItemLayout }) => {
 	
 	const columns = chartDesigner.columns;
 
-	console.log(chartDesigner.barConfig.groupBy);
 	return (
 		<Form hideRequiredMark={true}>
 			<FormItem label='横轴' {...formItemLayout}>

src/components/datasource/dataSource.jsx

@@ -56,8 +56,6 @@ class DataSource extends React.Component {
             )
         )).map(g => g.code);
 
-        console.log(list, groupFilter);
-
         return list.filter(l => groupFilter.indexOf(l.groupCode+'') !== -1);
     }
 
@@ -200,7 +198,6 @@ class DataSource extends React.Component {
                                     }} onPressEnter={(e) => {
                                         dispatch({ type: 'dataSource/remoteModifyGroup', group: {...c, label:e.target.value} });
                                     }} onCompositionEnd={(e) => {
-                                        console.log(e.target.value);
                                     }}/><Icon type='minus-circle' onClick={() => {
                                         dispatch({ type: 'dataSource/remoteDeleteGroup', group: c });
                                     }}/></div>) : p.label
@@ -228,7 +225,6 @@ class DataSource extends React.Component {
         const dragCode = info.dragNode.props.eventKey;
         const dropPos = info.node.props.pos.split('-');
         const dropPosition = info.dropPosition - Number(dropPos[dropPos.length - 1]); // -1/0/1 -> 兄/子/弟
-        console.log(dragCode, dropCode, dropPosition);
         dispatch({ type: 'dataSource/remoteMoveGroup', dragCode, dropCode, dropPosition });
     }
 

src/models/chart.js

@@ -118,6 +118,7 @@ export default {
                 const res = yield call(service.fetch, {
                     url: URLS.CHART_LIST
                 });
+                console.log('请求图表列表', res);
                 if(!res.err && res.data.code > 0) {
                     let list = res.data.data.map(d => {
                         return {
@@ -303,6 +304,7 @@ export default {
                     url: URLS.CHART_ADD,
                     body: body
                 })
+                console.log('新增图表', body, res);
                 if(!res.err && res.data.code > 0) {
                     message.success('新增成功');
                     yield put({ type: 'fetchList', mandatory: true });
@@ -391,6 +393,7 @@ export default {
                     url: URLS.CHART_DELETE,
                     body: [code]
                 });
+                console.log('删除图表', code, res);
                 if(!res.err && res.data.code > 0) {
                     for(let i = 0; i < list.length; i++) {
                         if(list[i].code === code) {
@@ -404,8 +407,8 @@ export default {
                     message.error('删除失败: ' + (res.err || res.data.msg));
                 }
             }catch(e) {
-                message.error('删除失败');
                 console.log(e);
+                message.error('删除失败');
             }
         },
         
@@ -419,7 +422,7 @@ export default {
                     url: URLS.GROUP_CHART_LIST,
                 });
                 
-                console.log(res);
+                console.log('请求图表分组列表', res);
                 if(!res.err && res.data.code > 0) {
                     const resData = res.data.data;
                     let data = resData.map(d => {
@@ -470,7 +473,7 @@ export default {
                     url: URLS.GROUP_CHART_ADD,
                     body: body
                 });
-                console.log('新增分组', body, res);
+                console.log('新增图表分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     let group = {
                         code: res.data.data + '',
@@ -510,7 +513,7 @@ export default {
                     url: URLS.GROUP_CHART_UPDATE,
                     body: body
                 });
-                
+                console.log('修改图表分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     yield put({ type: 'setGroupDirty', dirty: false });
                 }else {
@@ -541,7 +544,7 @@ export default {
                     url: URLS.GROUP_CHART_LIST_UPDATE,
                     body: body
                 });
-                
+                console.log('批量修改图表分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     yield put({ type: 'modifyGroups', groups: groups });
                 }else {
@@ -571,7 +574,7 @@ export default {
                     body: [group.code]
                 });
                 
-                console.log('删除分组', group.code, res);
+                console.log('删除图表分组', group.code, res);
                 if(!res.err && res.data.code > 0) {
                     yield put({ type: 'deleteGroup', group});
                 }else {

src/models/chartDesigner.js

@@ -217,6 +217,7 @@ export default {
                     url: URLS.CHART_ADD,
                     body: body
                 })
+                console.log('快速新增图表', body, res);
                 if(!res.err && res.data.data > 0) {
                     yield put({ type: 'chart/fetchList', mandatory: true });
                     yield put({ type: 'main/redirect', path: '/chart/' + res.data.data });

src/models/dataConnect.js

@@ -146,6 +146,7 @@ export default {
                 yield put({ type: 'setNewModelField', name: 'validating', value: true });
                 // 调用检测接口检测连接配置是否合法
                 let validBody = {
+                    id: model.code,
                     name: model.name,
                     addrass: model.address,
                     port: model.port,
@@ -159,6 +160,8 @@ export default {
                     body: validBody
                 });
 
+                console.log('校验数据连接配置', validBody, res);
+
                 // 设置validating为false
                 yield put({ type: 'setNewModelField', name: 'validating', value: false });
 
@@ -188,6 +191,7 @@ export default {
                     yield put({ type: 'setNewModelField', name: 'validating', value: true });
                     // 调用检测接口检测连接配置是否合法
                     let validBody = {
+                        id: model.code,
                         name: model.name,
                         addrass: model.address,
                         port: model.port,
@@ -253,6 +257,7 @@ export default {
                     yield put({ type: 'setNewModelField', name: 'validating', value: true });
                     // 调用检测接口检测连接配置是否合法
                     let validBody = {
+                        id: model.code,
                         name: model.name,
                         addrass: model.address,
                         port: model.port,
@@ -292,6 +297,7 @@ export default {
                         url: URLS.DATACONNECT_UPDATE,
                         body: data
                     });
+                    console.log('修改数据连接配置', data, res);
                     if(!res.err && res.data.code > 0) {
                         let list = dataConnect.list;
                         list = list.map(l => {

src/models/dataSource.js

@@ -193,7 +193,7 @@ export default {
                             groupCode: r.connectorGroup+'' === '-1' ? 'all' : r.connectorGroup+''
                         }
                     });
-                    console.log('获得数据源list', res, data);
+                    console.log('请求数据源列表', res, data);
                     yield put({ type: 'list', data });
                 }else {
                     message.error('读取数据源列表错误: ' + (res.err || res.data.msg));
@@ -448,7 +448,7 @@ export default {
                     url: URLS.GROUP_DATASOURCE_LIST,
                 });
                 
-                console.log(res);
+                console.log('请求数据源分组列表', res);
                 if(!res.err && res.data.code > 0) {
                     const resData = res.data.data;
                     let data = resData.map(d => {
@@ -461,10 +461,11 @@ export default {
                     });
                     yield put({ type: 'groupList', data });
                 }else {
-                    message.error('读取数据源列表错误: ' + (res.err || res.data.msg));
+                    message.error('请求数据源列表错误: ' + (res.err || res.data.msg));
                 }
             }catch(e) {
                 console.log(e);
+                message.error('请求数据源列表错误');
             }
         },
         /**
@@ -498,7 +499,7 @@ export default {
                     url: URLS.GROUP_DATASOURCE_ADD,
                     body: body
                 });
-                console.log('新增分组', body, res);
+                console.log('新增数据源分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     let group = {
                         code: res.data.data + '',
@@ -538,7 +539,7 @@ export default {
                     url: URLS.GROUP_DATASOURCE_UPDATE,
                     body: body
                 });
-                
+                console.log('修改数据源分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     yield put({ type: 'setGroupDirty', dirty: false });
                 }else {
@@ -570,6 +571,7 @@ export default {
                     body: body
                 });
                 
+                console.log('批量修改数据源分组', body, res);
                 if(!res.err && res.data.code > 0) {
                     yield put({ type: 'modifyGroups', groups: groups });
                 }else {