public/dataease
1
0
Fork 0
mirror of https://github.com/dataease/dataease.git synced 2026-05-16 05:50:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

perf(API 文档): 优化数据源管理 API 描述信息

Browse Source
This commit is contained in:
jianneng-fit2cloud
2025-03-07 11:11:01 +08:00
committed by jianneng-fit2cloud
parent 800359a7bd
commit 7db41bd8bb
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
sdk/api/api-base/src/main/java/io/dataease/api/ds/DatasourceDriverApi.java
View File

@@ -5,6 +5,7 @@ import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.api.ds.vo.DriveDTO;
import io.dataease.api.ds.vo.DriveJarDTO;
import io.dataease.extensions.datasource.dto.DatasourceDTO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
@@ -18,30 +19,39 @@ public interface DatasourceDriverApi {
* @param keyWord 过滤关键字
* @return
*/
@Operation(summary = "查询数据源树", hidden = true)
@GetMapping("/query/{keyWord}")
List<DatasourceDTO> query(@PathVariable("keyWord") String keyWord);
@Operation(summary = "列表")
@GetMapping("/list")
List<DriveDTO> list();
@Operation(summary = "根据数据源类型获取")
@GetMapping("/list/{dsType}")
List<DriveDTO> listByDsType(@PathVariable("dsType") String dsType);
@Operation(summary = "保存")
@PostMapping("/save")
DriveDTO save(@RequestBody DriveDTO datasourceDrive);
@Operation(summary = "更新")
@PostMapping("/update")
DriveDTO update(@RequestBody DriveDTO datasourceDrive);
@Operation(summary = "删除")
@PostMapping("/delete/{driverId}")
void delete(@PathVariable("driverId") String driverId);
@Operation(summary = "获取驱动jar列表")
@GetMapping("/listDriverJar/{driverId}")
List<DriveJarDTO> listDriverJar(@PathVariable("driverId") String driverId);
@Operation(summary = "删除驱动jar")
@PostMapping("/deleteDriverJar/{jarId}")
void deleteDriverJar(@PathVariable("jarId") String jarId);
@Operation(summary = "上传驱动jar")
@PostMapping("/uploadJar")
DriveJarDTO uploadJar(@RequestParam("deDriverId") String deDriverId, @RequestParam("jarFile") MultipartFile jarFile) throws Exception;
}

6
sdk/api/api-base/src/main/java/io/dataease/api/ds/EngineApi.java
View File

@@ -3,6 +3,7 @@ package io.dataease.api.ds;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.auth.DeApiPath;
import io.dataease.extensions.datasource.dto.DatasourceDTO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
@@ -13,18 +14,23 @@ import static io.dataease.constant.AuthResourceEnum.DATASOURCE;
@DeApiPath(value = "/engine", rt = DATASOURCE)
public interface EngineApi {
@Operation(summary = "查询")
@GetMapping("/getEngine")
DatasourceDTO getEngine();
@Operation(summary = "保存")
@PostMapping("/save")
void save(@RequestBody DatasourceDTO datasourceDTO);
@Operation(summary = "校验")
@PostMapping("/validate")
void validate(@RequestBody DatasourceDTO datasourceDTO) throws Exception;
@Operation(summary = "根据ID校验")
@PostMapping("/validate/{id}")
void validateById(@PathVariable Long id) throws Exception;
@Operation(summary = "是否支持设置主键")
@GetMapping("/supportSetKey")
boolean supportSetKey() throws Exception;
}