center/dataease-dm
center/dataease-dm
13
0
Fork 0
forked from github/dataease
Code Pull Requests Activity

Merge pull request #7491 from dataease/pr@dev-v2@refactor_api

Browse Source 
refactor: 更新api文档
This commit is contained in:
王嘉豪 2024-01-02 14:10:54 +08:00 committed by GitHub
commit e156a9b6e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 63 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
sdk/api/api-base/src/main/java/io/dataease/api/template/TemplateManageApi.java
View File

@ -4,42 +4,56 @@ import io.dataease.api.template.dto.TemplateManageDTO;
import io.dataease.api.template.request.TemplateManageBatchRequest;
import io.dataease.api.template.request.TemplateManageRequest;
import io.dataease.api.template.vo.VisualizationTemplateVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@Tag(name = "模版管理:基础")
public interface TemplateManageApi {
@PostMapping("/templateList")
List<TemplateManageDTO> templateList(@RequestBody TemplateManageRequest request);
@Operation(summary = "模版列表")
List<TemplateManageDTO> templateList(@RequestBody TemplateManageRequest request);
@PostMapping("/save")
@Operation(summary = "保存")
TemplateManageDTO save(@RequestBody TemplateManageRequest request);
@PostMapping("/delete/{id}/{categoryId}")
@Operation(summary = "删除")
void delete(@PathVariable String id,@PathVariable String categoryId);
@PostMapping("/deleteCategory/{id}")
@Operation(summary = "删除分类")
String deleteCategory(@PathVariable String id);
@GetMapping("/findOne/{templateId}")
@Operation(summary = "明细查询")
VisualizationTemplateVO findOne(@PathVariable String templateId) throws Exception;
@PostMapping("/find")
@Operation(summary = "查询")
List<TemplateManageDTO> find(@RequestBody TemplateManageRequest request);
@PostMapping("/findCategories")
@Operation(summary = "分类明细查询")
List<TemplateManageDTO> findCategories(@RequestBody TemplateManageRequest request);
@PostMapping("/nameCheck")
@Operation(summary = "模版名称校验")
String nameCheck(@RequestBody TemplateManageRequest request);
@PostMapping("/categoryTemplateNameCheck")
@Operation(summary = "分类名称校验")
String categoryTemplateNameCheck(@RequestBody TemplateManageRequest request);
@PostMapping("/batchUpdate")
@Operation(summary = "批量更新")
void batchUpdate(@RequestBody TemplateManageBatchRequest request);
@PostMapping("/batchDelete")
@Operation(summary = "批量删除")
void batchDelete(@RequestBody TemplateManageBatchRequest request);
}

8
sdk/api/api-base/src/main/java/io/dataease/api/template/TemplateMarketApi.java
View File

@ -4,6 +4,8 @@ import io.dataease.api.template.request.TemplateMarketSearchRequest;
import io.dataease.api.template.response.MarketBaseResponse;
import io.dataease.api.template.response.MarketPreviewBaseResponse;
import io.dataease.api.template.vo.MarketMetaDataVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
@ -14,20 +16,26 @@ import java.util.List;
* @author : WangJiaHao
* @date : 2023/11/6 17:23
*/
@Tag(name = "模版中心:基础")
public interface TemplateMarketApi {
@GetMapping("/search")
@Operation(summary = "查询")
MarketBaseResponse searchTemplate();
@GetMapping("/searchRecommend")
@Operation(summary = "查询基础信息")
MarketBaseResponse searchTemplateRecommend();
@GetMapping("/searchPreview")
@Operation(summary = "预览")
MarketPreviewBaseResponse searchTemplatePreview();
@GetMapping("/categories")
@Operation(summary = "分类")
List<String> categories();
@GetMapping("/categoriesObject")
@Operation(summary = "分类明细")
List<MarketMetaDataVO> categoriesObject() ;
}

14
sdk/api/api-base/src/main/java/io/dataease/api/visualization/DataVisualizationApi.java
View File

@ -11,6 +11,7 @@ import io.dataease.auth.DeApiPath;
import io.dataease.auth.DePermit;
import io.dataease.model.BusiNodeRequest;
import io.dataease.model.BusiNodeVO;
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;
@ -30,43 +31,54 @@ public interface DataVisualizationApi {
*/
@GetMapping("/findById/{dvId}/{busiFlag}")
@DePermit(value = {"#p0+':read'"}, busiFlag = "#p1")
@Operation(summary = "查询可视化资源")
DataVisualizationVO findById(@PathVariable("dvId") Long dvId,@PathVariable("busiFlag") String busiFlag);
@PostMapping("/saveCanvas")
@DePermit(value = {"#p0.pid + ':manage'"}, busiFlag = "#p0.type")
@Operation(summary = "画布保存")
String saveCanvas(@RequestBody DataVisualizationBaseRequest request);
@PostMapping("/updateCanvas")
@DePermit(value = {"#p0.id + ':manage'"}, busiFlag = "#p0.type")
@Operation(summary = "画布更新")
void updateCanvas(@RequestBody DataVisualizationBaseRequest request);
@PostMapping("/updateBase")
@DePermit(value = {"#p0.id + ':manage'"}, busiFlag = "#p0.type")
@Operation(summary = "可视化资源基础信息更新")
void updateBase(@RequestBody DataVisualizationBaseRequest request);
@DeleteMapping("/deleteLogic/{dvId}/{busiFlag}")
@DePermit(value = {"#p0+':manage'"}, busiFlag = "#p1")
@Operation(summary = "可视化资源删除")
void deleteLogic(@PathVariable("dvId") Long dvId,@PathVariable("busiFlag") String busiFlag);
@PostMapping("/tree")
@Operation(summary = "查询可视化资源树")
List<BusiNodeVO> tree(@RequestBody BusiNodeRequest request);
@PostMapping("/move")
@DePermit(value = {"#p0.id+':manage'", "#p0.pid+':manage'"}, busiFlag = "#p0.type")
@Operation(summary = "移动可视化资")
void move(@RequestBody DataVisualizationBaseRequest request);
@PostMapping("/nameCheck")
@Operation(summary = "名称校验")
void nameCheck(@RequestBody DataVisualizationBaseRequest request);
@PostMapping("/findRecent")
@Operation(summary = "查询最近操作资源")
List<VisualizationResourceVO> findRecent(@RequestBody VisualizationWorkbranchQueryRequest request);
@PostMapping("/copy")
@JsonSerialize(using = ToStringSerializer.class)
@DePermit(value = {"#p0.id+':manage'", "#p0.pid+':manage'"}, busiFlag = "#p0.type")
@Operation(summary = "复制")
String copy(@RequestBody DataVisualizationBaseRequest request);
@GetMapping("/findDvType/{dvId}")
@Operation(summary = "查询可视化资源类型")
String findDvType(@PathVariable("dvId")Long dvId);
/**
@ -75,6 +87,7 @@ public interface DataVisualizationApi {
* @return
*/
@PostMapping("/decompression")
@Operation(summary = "解析可视化资源模板信息")
DataVisualizationVO decompression(@RequestBody DataVisualizationBaseRequest request) throws Exception;
/**
@ -83,6 +96,7 @@ public interface DataVisualizationApi {
* @return
*/
@PostMapping("/decompressionLocalFile")
@Operation(summary = "解析可视化资源模板文件信息")
DataVisualizationVO decompressionLocalFile(@RequestPart(value = "file") MultipartFile file);
}

2
sdk/api/api-base/src/main/java/io/dataease/api/visualization/VisualizationBackgroundApi.java
View File

@ -3,6 +3,7 @@ package io.dataease.api.visualization;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.api.visualization.request.VisualizationBackgroundRequest;
import io.dataease.api.visualization.vo.VisualizationBackgroundVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
@ -18,5 +19,6 @@ import java.util.Map;
@ApiSupport(order = 997)
public interface VisualizationBackgroundApi {
@GetMapping("/findAll")
@Operation(summary = "背景信息查询")
Map<String, List<VisualizationBackgroundVO>> findAll();
}

8
sdk/api/api-base/src/main/java/io/dataease/api/visualization/VisualizationLinkJumpApi.java
View File

@ -6,6 +6,7 @@ import io.dataease.api.visualization.request.VisualizationLinkJumpBaseRequest;
import io.dataease.api.visualization.response.VisualizationLinkJumpBaseResponse;
import io.dataease.api.visualization.vo.VisualizationViewTableVO;
import io.dataease.dto.dataset.DatasetTableFieldDTO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@ -24,23 +25,30 @@ public interface VisualizationLinkJumpApi {
@GetMapping("/getTableFieldWithViewId/{viewId}")
@Operation(summary = "查询可跳转字段信息")
List<DatasetTableFieldDTO> getTableFieldWithViewId(@PathVariable Long viewId);
@GetMapping("/queryWithViewId/{dvId}/{viewId}")
@Operation(summary = "根据视图ID查询跳转信息")
VisualizationLinkJumpDTO queryWithViewId(@PathVariable Long dvId, @PathVariable Long viewId);
@GetMapping("/queryVisualizationJumpInfo/{dvId}")
@Operation(summary = "根据可视化资源ID查询跳转信息")
VisualizationLinkJumpBaseResponse queryVisualizationJumpInfo(@PathVariable Long dvId);
@PostMapping("/updateJumpSet")
@Operation(summary = "更新跳转信息")
void updateJumpSet(@RequestBody VisualizationLinkJumpDTO jumpDTO);
@PostMapping("/queryTargetVisualizationJumpInfo")
@Operation(summary = "查询目标跳转信息")
VisualizationLinkJumpBaseResponse queryTargetVisualizationJumpInfo(@RequestBody VisualizationLinkJumpBaseRequest request);
@GetMapping("/viewTableDetailList/{dvId}")
@Operation(summary = "查询跳转明细")
List<VisualizationViewTableVO> viewTableDetailList(@PathVariable Long dvId);
@PostMapping("/updateJumpSetActive")
@Operation(summary = "更新跳转信息可用状态")
VisualizationLinkJumpBaseResponse updateJumpSetActive(@RequestBody VisualizationLinkJumpBaseRequest request);
}

8
sdk/api/api-base/src/main/java/io/dataease/api/visualization/VisualizationLinkageApi.java
View File

@ -3,6 +3,7 @@ package io.dataease.api.visualization;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.api.commons.BaseRspModel;
import io.dataease.api.visualization.request.VisualizationLinkageRequest;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@ -17,24 +18,29 @@ import java.util.Map;
* @date : 2023/7/13
*/
@Tag(name = "可视化管理:链接")
@Tag(name = "可视化管理:联动")
@ApiSupport(order = 996)
public interface VisualizationLinkageApi {
@PostMapping("/getViewLinkageGather")
@Operation(summary = "查询联动信息")
Map getViewLinkageGather(@RequestBody VisualizationLinkageRequest request);
@PostMapping("/getViewLinkageGatherArray")
@Operation(summary = "查询联动信息数组")
List getViewLinkageGatherArray(@RequestBody VisualizationLinkageRequest request);
@PostMapping("/saveLinkage")
@Operation(summary = "保存联动信息")
BaseRspModel saveLinkage(@RequestBody VisualizationLinkageRequest request);
@GetMapping("/getVisualizationAllLinkageInfo/{dvId}")
@Operation(summary = "根据资源ID查询联动信息")
Map<String, List<String>> getVisualizationAllLinkageInfo(@PathVariable Long dvId);
@PostMapping("/updateLinkageActive")
@Operation(summary = "修改联动信息可用状态")
Map updateLinkageActive(@RequestBody VisualizationLinkageRequest request);
}

4
sdk/api/api-base/src/main/java/io/dataease/api/visualization/VisualizationStoreApi.java
View File

@ -4,6 +4,7 @@ import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.api.visualization.request.VisualizationStoreRequest;
import io.dataease.api.visualization.request.VisualizationWorkbranchQueryRequest;
import io.dataease.api.visualization.vo.VisualizationStoreVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@ -17,10 +18,13 @@ import java.util.List;
public interface VisualizationStoreApi {
@PostMapping("/execute")
@Operation(summary = "变更收藏信息")
void execute(@RequestBody VisualizationStoreRequest request);
@PostMapping("/query")
@Operation(summary = "查询收藏资源信息")
List<VisualizationStoreVO> query(@RequestBody VisualizationWorkbranchQueryRequest request);
@GetMapping("/favorited/{id}")
@Operation(summary = "收藏")
boolean favorited(@PathVariable("id") Long id);
}

5
sdk/api/api-base/src/main/java/io/dataease/api/visualization/VisualizationSubjectApi.java
View File

@ -3,6 +3,7 @@ package io.dataease.api.visualization;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import io.dataease.api.visualization.request.VisualizationSubjectRequest;
import io.dataease.api.visualization.vo.VisualizationSubjectVO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
@ -13,15 +14,19 @@ import java.util.List;
public interface VisualizationSubjectApi {
@PostMapping("/query")
@Operation(summary = "查询")
List<VisualizationSubjectVO> query(@RequestBody VisualizationSubjectRequest request);
@PostMapping("/querySubjectWithGroup")
@Operation(summary = "分组查询")
List<VisualizationSubjectVO> querySubjectWithGroup(@RequestBody VisualizationSubjectRequest request);
@PostMapping("/update")
@Operation(summary = "更新")
void update(@RequestBody VisualizationSubjectRequest request);
@DeleteMapping("/delete/{id}")
@Operation(summary = "删除")
void delete(@PathVariable String id);
}