# 接口设计 - 数据连接 ## 新增数据连接配置 ##### 请求路径 `/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 | 说明 | ##### 请求示例 ```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 } ``` ##### 详细说明 ___ ## 修改数据连接配置 ##### 请求路径 `/updatabases` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataConnect/remoteModify')` ##### 请求参数 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 } ``` ##### 详细说明 ___ ## 删除数据连接配置 ##### 请求路径 `/delDatabases` ##### 请求方式 `HTTP - POST` ##### 包类方法 `dispatch(type:'dataConnect/remoteDelete')` ##### 请求参数 id : code ##### 请求示例 ```json 83 ``` ##### 返回结果 ``` { "code": 200, "msg": "成功", "data": null } ``` ##### 详细说明 ___ ## 获得数据连接列表 ##### 请求路径 `/getDatabases` ##### 请求方式 `HTTP - POST` ##### 包类方法 `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 } ] } ``` ##### 详细说明 ___ ## 校验数据库连接是否合法 ##### 请求路径 `/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 | 密码 | ##### 请求示例 ```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": {} } } ``` ##### 详细说明