|
|
@ -2,23 +2,37 @@ |
|
|
|
|
|
|
|
|
|
|
|
## 调用示例代码 |
|
|
|
## 调用示例代码 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 开启API数据源 |
|
|
|
|
|
|
|
|
|
|
|
```java |
|
|
|
```java |
|
|
|
Authentication authentication = new Authentication("#key", "#secret"); |
|
|
|
Authentication authentication = new Authentication("#key", "#secret"); |
|
|
|
DatasourceOperation operation = new DatasourceOperation(authentication); |
|
|
|
DatasourceOperation operation = new DatasourceOperation(authentication); |
|
|
|
operation.open(); |
|
|
|
operation.open(); |
|
|
|
// 创建一个分组,如果已经存在,则直接跳过 |
|
|
|
``` |
|
|
|
operation.createGroup("TestGroup"); |
|
|
|
|
|
|
|
// 在分组下创建一个表,返回创建的表的ID,如果表已经存在,则直接返回表ID |
|
|
|
在开启后,可以在企业数据的"数据导入"菜单看到如下图所示的API数据源入口 |
|
|
|
String tableId = operation.createTable("HelloTable", "TestGroup"); |
|
|
|
![api_datasource](/screenshots/api_datasource.png) |
|
|
|
// 获取上传文件的url |
|
|
|
|
|
|
|
|
|
|
|
### |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
|
|
|
Authentication authentication = new Authentication("#key", "#secret"); |
|
|
|
|
|
|
|
DatasourceOperation operation = new DatasourceOperation(authentication); |
|
|
|
|
|
|
|
// // 创建表并返回表id |
|
|
|
|
|
|
|
String tableId = operation.createTable("HelloTable"); |
|
|
|
|
|
|
|
// 获取给该表提供数据的文件的上传地址 |
|
|
|
String fileUploadUrl = operation.requestUploadUrl(tableId); |
|
|
|
String fileUploadUrl = operation.requestUploadUrl(tableId); |
|
|
|
// 将数据文件上传 |
|
|
|
// 将数据文件上传 |
|
|
|
HttpKits.upload(fileUploadUrl, new File(System.getProperty("user.dir") + "/data/地区数据分析.csv")); |
|
|
|
HttpKits.upload(fileUploadUrl, new File(System.getProperty("user.dir") + "/data/地区数据分析.csv")); |
|
|
|
// 标记该表的数据已经上传完成 |
|
|
|
// 标记该表的数据已经上传完成 |
|
|
|
operation.markAsFinish(tableId); |
|
|
|
operation.markAsFinish(tableId); |
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
在调用了上述代码后,就可以在API数据源页面看到新增的表和其数据了,这时就可以和其他数据源表一样,添加到项目中使用了: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![api_datasource_effect](/screenshots/api_datasource_effect.png) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## API文档 |
|
|
|
## API文档 |
|
|
|
|
|
|
|
|
|
|
|
### 开启API数据源 |
|
|
|
### 开启API数据源 |
|
|
@ -52,14 +66,14 @@ operation.markAsFinish(tableId); |
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
### 分组管理 |
|
|
|
### 分组管理 |
|
|
|
#### 创建分组 |
|
|
|
#### 创建分组(暂未启用) |
|
|
|
请求地址:```/api/v1/datasource/group/create``` |
|
|
|
请求地址:```/api/v1/datasource/group/create``` |
|
|
|
|
|
|
|
|
|
|
|
请求类型:POST |
|
|
|
请求类型:POST |
|
|
|
|
|
|
|
|
|
|
|
请求参数:```{"name":"#分组名"}``` |
|
|
|
请求参数:```{"name":"#分组名"}``` |
|
|
|
|
|
|
|
|
|
|
|
#### 读取所有分组 |
|
|
|
#### 读取所有分组(暂未启用) |
|
|
|
请求地址:```/api/v1/datasource/group/list``` |
|
|
|
请求地址:```/api/v1/datasource/group/list``` |
|
|
|
|
|
|
|
|
|
|
|
请求类型:POST |
|
|
|
请求类型:POST |
|
|
@ -70,8 +84,16 @@ operation.markAsFinish(tableId); |
|
|
|
|
|
|
|
|
|
|
|
请求类型:POST |
|
|
|
请求类型:POST |
|
|
|
|
|
|
|
|
|
|
|
请求参数: ``` {"group":"#分组名", "name":"#表名"} ```,分组名可以不传,默认值为“默认” |
|
|
|
请求参数: ``` {"tableName":"#表名"} ``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值: |
|
|
|
|
|
|
|
```json |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
"success": true, |
|
|
|
|
|
|
|
"code": "200", |
|
|
|
|
|
|
|
"data":"2469965eae4d45339448fb1e74d2b733" |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
#### 获取表数据上传地址 |
|
|
|
#### 获取表数据上传地址 |
|
|
|
请求地址:```/api/v1/datasource/table/upload/url``` |
|
|
|
请求地址:```/api/v1/datasource/table/upload/url``` |
|
|
@ -80,6 +102,15 @@ operation.markAsFinish(tableId); |
|
|
|
|
|
|
|
|
|
|
|
请求参数:``` {"tableId":"#表Id"} ``` |
|
|
|
请求参数:``` {"tableId":"#表Id"} ``` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值: |
|
|
|
|
|
|
|
```json |
|
|
|
|
|
|
|
{ |
|
|
|
|
|
|
|
"success": true, |
|
|
|
|
|
|
|
"code": "200", |
|
|
|
|
|
|
|
"data":"upload_url" |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
#### 标记表数据已上传完成 |
|
|
|
#### 标记表数据已上传完成 |
|
|
|
请求地址:```/api/v1/datasource/table/upload/finish``` |
|
|
|
请求地址:```/api/v1/datasource/table/upload/finish``` |
|
|
|
|
|
|
|
|
|
|
|