From 09c5816d8eb1b10b6e32932bb619dd03e3f72753 Mon Sep 17 00:00:00 2001 From: wangjiahao <1522128093@qq.com> Date: Mon, 11 Oct 2021 15:31:17 +0800 Subject: [PATCH] =?UTF-8?q?refactor:=20api=20=E4=BF=A1=E6=81=AF=E8=A1=A5?= =?UTF-8?q?=E5=85=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dataease/commons/model/BaseRspModel.java | 23 +++++++++++++++++++ .../io/dataease/controller/ResultHolder.java | 4 ++++ .../panel/PanelDesignController.java | 4 +++- .../panel/PanelViewLinkageController.java | 4 +++- .../controller/panel/api/LinkApi.java | 4 ++-- .../controller/panel/api/ShareApi.java | 5 ++-- 6 files changed, 37 insertions(+), 7 deletions(-) create mode 100644 backend/src/main/java/io/dataease/commons/model/BaseRspModel.java diff --git a/backend/src/main/java/io/dataease/commons/model/BaseRspModel.java b/backend/src/main/java/io/dataease/commons/model/BaseRspModel.java new file mode 100644 index 0000000000..c2478a9147 --- /dev/null +++ b/backend/src/main/java/io/dataease/commons/model/BaseRspModel.java @@ -0,0 +1,23 @@ +package io.dataease.commons.model; + + +import io.swagger.annotations.ApiModelProperty; +import lombok.Data; + +import java.io.Serializable; +import java.util.List; + +@Data +public class BaseRspModel implements Serializable { + + @ApiModelProperty("成功标志") + private Boolean success = true; + + @ApiModelProperty("请求ID") + private String requestId; + + @ApiModelProperty("返回业务信息") + private Object responseInfo; + + +} diff --git a/backend/src/main/java/io/dataease/controller/ResultHolder.java b/backend/src/main/java/io/dataease/controller/ResultHolder.java index 4b5d9f3a9a..73a49a2dfa 100644 --- a/backend/src/main/java/io/dataease/controller/ResultHolder.java +++ b/backend/src/main/java/io/dataease/controller/ResultHolder.java @@ -1,5 +1,6 @@ package io.dataease.controller; +import io.swagger.annotations.ApiModelProperty; import org.apache.commons.lang3.builder.ReflectionToStringBuilder; import org.apache.commons.lang3.builder.ToStringStyle; import springfox.documentation.annotations.ApiIgnore; @@ -27,10 +28,13 @@ public class ResultHolder { } // 请求是否成功 + @ApiModelProperty("请求是否成功") private boolean success = false; // 描述信息 + @ApiModelProperty("描述信息") private String message; // 返回数据 + @ApiModelProperty("返回数据") private Object data = ""; public boolean isSuccess() { diff --git a/backend/src/main/java/io/dataease/controller/panel/PanelDesignController.java b/backend/src/main/java/io/dataease/controller/panel/PanelDesignController.java index 1e9f2d2fa9..af9601df52 100644 --- a/backend/src/main/java/io/dataease/controller/panel/PanelDesignController.java +++ b/backend/src/main/java/io/dataease/controller/panel/PanelDesignController.java @@ -1,6 +1,7 @@ package io.dataease.controller.panel; import com.github.xiaoymin.knife4j.annotations.ApiSupport; +import io.dataease.commons.model.BaseRspModel; import io.dataease.service.panel.PanelGroupService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; @@ -24,8 +25,9 @@ public class PanelDesignController { @ApiOperation("保存仪表板设计") @PostMapping("/saveDesign/{id}") - public void deleteCircle(@PathVariable String id) { + public BaseRspModel deleteCircle(@PathVariable String id) { panelGroupService.deleteCircle(id); + return new BaseRspModel(); } diff --git a/backend/src/main/java/io/dataease/controller/panel/PanelViewLinkageController.java b/backend/src/main/java/io/dataease/controller/panel/PanelViewLinkageController.java index 5dae15e2ef..4aa8868c36 100644 --- a/backend/src/main/java/io/dataease/controller/panel/PanelViewLinkageController.java +++ b/backend/src/main/java/io/dataease/controller/panel/PanelViewLinkageController.java @@ -1,6 +1,7 @@ package io.dataease.controller.panel; import com.github.xiaoymin.knife4j.annotations.ApiSupport; +import io.dataease.commons.model.BaseRspModel; import io.dataease.controller.request.panel.PanelLinkageRequest; import io.dataease.dto.PanelViewLinkageDTO; import io.dataease.service.panel.PanelViewLinkageService; @@ -35,8 +36,9 @@ public class PanelViewLinkageController { @ApiOperation("保存仪表板视图联动信息") @PostMapping("/saveLinkage") - public void saveLinkage(@RequestBody PanelLinkageRequest request){ + public BaseRspModel saveLinkage(@RequestBody PanelLinkageRequest request){ panelViewLinkageService.saveLinkage(request); + return new BaseRspModel(); } diff --git a/backend/src/main/java/io/dataease/controller/panel/api/LinkApi.java b/backend/src/main/java/io/dataease/controller/panel/api/LinkApi.java index 96e95b94a9..b37daef68e 100644 --- a/backend/src/main/java/io/dataease/controller/panel/api/LinkApi.java +++ b/backend/src/main/java/io/dataease/controller/panel/api/LinkApi.java @@ -21,7 +21,7 @@ import java.util.Map; public interface LinkApi { - @ApiOperation("重制密码") + @ApiOperation("重置密码") @PostMapping("/resetPwd") void replacePwd(PasswordRequest request); @@ -29,7 +29,7 @@ public interface LinkApi { @PostMapping("/enablePwd") void enablePwd(EnablePwdRequest request); - @ApiOperation("切换开关") + @ApiOperation("启用/禁用链接分享") @PostMapping("/switchLink") void switchLink(LinkRequest request); diff --git a/backend/src/main/java/io/dataease/controller/panel/api/ShareApi.java b/backend/src/main/java/io/dataease/controller/panel/api/ShareApi.java index 5d3833dc39..a01dcd4b7e 100644 --- a/backend/src/main/java/io/dataease/controller/panel/api/ShareApi.java +++ b/backend/src/main/java/io/dataease/controller/panel/api/ShareApi.java @@ -23,7 +23,6 @@ import java.util.List; public interface ShareApi { @ApiIgnore - @ApiOperation("创建分享") @PostMapping("/") void share(PanelShareRequest request); @@ -37,8 +36,8 @@ public interface ShareApi { List queryWithResourceId(BaseGridRequest request); - @ApiOperation("优化创建分享") + @ApiOperation("创建分享") @PostMapping("/fineSave") void fineSave(PanelShareFineDto panelShareFineDto); - + }