diff --git a/quality-review/src/main/java/com/ruoyi/domain/ReviewSceneChangeTask.java b/quality-review/src/main/java/com/ruoyi/domain/ReviewSceneChangeTask.java index 730704d28e5b037d799bbb53346370e2fb192efa..283187d741da20bdd6e948201516b6b5614b3ab0 100644 --- a/quality-review/src/main/java/com/ruoyi/domain/ReviewSceneChangeTask.java +++ b/quality-review/src/main/java/com/ruoyi/domain/ReviewSceneChangeTask.java @@ -5,6 +5,9 @@ import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; import java.util.Date; + +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.experimental.Accessors; @@ -12,6 +15,7 @@ import lombok.experimental.Accessors; * å®¡æŸ¥åœºæ™¯å˜æ›´ä»»åŠ¡ * @TableName t_review_scene_change_task */ +@ApiModel(value = "ReviewSceneChangeTask", description = "åœºæ™¯å˜æ›´ä»»åŠ¡") @TableName(value ="t_review_scene_change_task") @Accessors(chain = true) @Data @@ -45,102 +49,122 @@ public class ReviewSceneChangeTask { /** * 主键 */ + @ApiModelProperty("主键") @TableId(type = IdType.ASSIGN_ID) private Long id; /** * ä»»åŠ¡ç¼–å· */ + @ApiModelProperty("任务编å·") private String taskNo; /** * ç« èŠ‚ */ + @ApiModelProperty("ç« èŠ‚") private String chapter; /** * å®¡æŸ¥æ ‡å‡†id */ + @ApiModelProperty("å®¡æŸ¥æ ‡å‡†id") private Long standardId; /** * å®¡æŸ¥æ ‡å‡† */ + @ApiModelProperty("å®¡æŸ¥æ ‡å‡†") private String standard; /** * 审查è¦ç‚¹id */ + @ApiModelProperty("审查è¦ç‚¹id") private Long keypointId; /** * 审查è¦ç‚¹ */ + @ApiModelProperty("审查è¦ç‚¹") private String keypoint; /** * 审查细则id */ + @ApiModelProperty("审查细则id") private Long detailsId; /** * 审查细则 */ + @ApiModelProperty("审查细则") private String details; /** - * æ“作(ADD DELETE UPDATE) + * æ“作 [ADD DELETE UPDATE] */ + @ApiModelProperty(value = "æ“作" , notes = "[ADD DELETE UPDATE]") private String operation; /** * 当 operation 为 ADD æ—¶è¯¥å—æ®µä¸ºç©º */ + @ApiModelProperty(value = "场景旧值", notes = "当 operation 为 ADD æ—¶è¯¥å—æ®µä¸ºç©º") private String oldText; /** * 当 operation 为 DELETE æ—¶è¯¥å—æ®µä¸ºç©º */ + @ApiModelProperty(value = "场景新值", notes = "当 operation 为 DELETE æ—¶è¯¥å—æ®µä¸ºç©º") private String newText; /** * 任务å‘起人姓å */ + @ApiModelProperty("任务å‘起人姓å") private String taskInitiator; /** * 任务å‘起人部门 */ + @ApiModelProperty("任务å‘起人部门") private String taskInitiatorDept; /** * 任务å‘起人Id */ + @ApiModelProperty("任务å‘起人Id") private Long taskInitiatorId; /** - * 任务状æ€ï¼ˆPENDINGã€FINISHã€CLOSE) + * ä»»åŠ¡çŠ¶æ€ [PENDINGã€FINISHã€CLOSE] */ + @ApiModelProperty(value = "任务状æ€", notes = "[PENDINGã€FINISHã€CLOSE]") private String taskStatus; /** - * 任务结果(PASSã€REJECT) + * 任务结果 [PASSã€REJECT] */ + @ApiModelProperty(value = "任务结果", notes = "[PASSã€REJECT]") private String taskResult; /** * 任务开始时间 */ + @ApiModelProperty("任务开始时间") private Date taskBeginTime; /** * ä»»åŠ¡ç»“æŸæ—¶é—´ */ + @ApiModelProperty("ä»»åŠ¡ç»“æŸæ—¶é—´") private Date taskEndTime; /** * 备注 */ + @ApiModelProperty("备注") private String remark; /** @@ -148,6 +172,7 @@ public class ReviewSceneChangeTask { * 若为修改ã€åˆ 除任务时,æ¤id在创建任务时赋值 * 若为新增任务时,æ¤id在审批通过并ä¿å˜æ–°åœºæ™¯åŽèµ‹å€¼ */ + @ApiModelProperty(value = "审查场景id", notes = "1.若为修改ã€åˆ 除任务时,æ¤id在创建任务时赋值; 2.若为新增任务时,æ¤id在审批通过并ä¿å˜æ–°åœºæ™¯åŽèµ‹å€¼ ") private Long reviewSceneId; } diff --git a/quality-review/src/main/java/com/ruoyi/web/ReviewSceneChangeTaskController.java b/quality-review/src/main/java/com/ruoyi/web/ReviewSceneChangeTaskController.java index a829ce37866100c62bbe81b559e712b04fd3c590..a80af0810874820fa49739fb8b9014907d4c1d74 100644 --- a/quality-review/src/main/java/com/ruoyi/web/ReviewSceneChangeTaskController.java +++ b/quality-review/src/main/java/com/ruoyi/web/ReviewSceneChangeTaskController.java @@ -10,6 +10,8 @@ import com.ruoyi.domain.ReviewSceneChangeTask; import com.ruoyi.service.ReviewSceneChangeTaskService; import com.ruoyi.web.request.ReviewSceneChangeTaskCreateRequest; import com.ruoyi.web.request.ReviewSceneChangeTaskPassRequest; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; import org.apache.skywalking.apm.toolkit.trace.Tag; import org.apache.skywalking.apm.toolkit.trace.Tags; import org.apache.skywalking.apm.toolkit.trace.Trace; @@ -20,6 +22,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; +@Api("åœºæ™¯å˜æ›´ä»»åŠ¡") @RestController @RequestMapping("/review/scene/change/task") public class ReviewSceneChangeTaskController extends BaseController { @@ -27,6 +30,7 @@ public class ReviewSceneChangeTaskController extends BaseController { @Autowired private ReviewSceneChangeTaskService reviewSceneChangeTaskService; + @ApiOperation("æ–°å»ºåœºæ™¯å˜æ›´ä»»åŠ¡") @Trace @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")}) @Log(title = "åœºæ™¯å˜æ›´ä»»åŠ¡", businessType = BusinessType.INSERT) @@ -66,10 +70,11 @@ public class ReviewSceneChangeTaskController extends BaseController { * æ ¹æ®ç”¨æˆ·ID查询待办列表 * @return */ + @ApiOperation("æ ¹æ®ç”¨æˆ·ID查询待办列表") @Trace @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")}) @RequestMapping(method = RequestMethod.POST, value = "/findPending") - public TableDataInfo findPending() { + public TableDataInfo<ReviewSceneChangeTask> findPending() { startPage(); return getDataTable(reviewSceneChangeTaskService.findPendingListByUserId(getUserId())); } @@ -78,10 +83,11 @@ public class ReviewSceneChangeTaskController extends BaseController { * æ ¹æ®ç”¨æˆ·ID查询已办列表 * @return */ + @ApiOperation("æ ¹æ®ç”¨æˆ·ID查询已办列表") @Trace @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")}) @RequestMapping(method = RequestMethod.POST, value = "/findFinish") - public TableDataInfo findFinish() { + public TableDataInfo<ReviewSceneChangeTask> findFinish() { startPage(); return getDataTable(reviewSceneChangeTaskService.findFinishListByUserId(getUserId())); } @@ -90,10 +96,11 @@ public class ReviewSceneChangeTaskController extends BaseController { * 查询当å‰ç”¨æˆ·å‘布的任务 * @return */ + @ApiOperation("查询当å‰ç”¨æˆ·å‘布的任务") @Trace @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")}) @RequestMapping(method = RequestMethod.POST, value = "/findCreate") - public TableDataInfo findCreate() { + public TableDataInfo<ReviewSceneChangeTask> findCreate() { startPage(); return getDataTable(reviewSceneChangeTaskService.findCreateListByUserId(getUserId())); } diff --git a/quality-review/src/main/java/com/ruoyi/web/request/ReviewSceneChangeTaskCreateRequest.java b/quality-review/src/main/java/com/ruoyi/web/request/ReviewSceneChangeTaskCreateRequest.java index 3c2603958d3a15b13442592460b767f9a4bdb6dd..2e9e8d6d53f8c25c9698dc721d4594759606cbd0 100644 --- a/quality-review/src/main/java/com/ruoyi/web/request/ReviewSceneChangeTaskCreateRequest.java +++ b/quality-review/src/main/java/com/ruoyi/web/request/ReviewSceneChangeTaskCreateRequest.java @@ -1,63 +1,77 @@ package com.ruoyi.web.request; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; +@ApiModel(value = "ReviewSceneChangeTaskCreateRequest", description = "新建场景") @Data public class ReviewSceneChangeTaskCreateRequest { /** * ç« èŠ‚ */ + @ApiModelProperty("ç« èŠ‚") private String chapter; /** * å®¡æŸ¥æ ‡å‡†id */ + @ApiModelProperty("å®¡æŸ¥æ ‡å‡†id") private Long standardId; /** * å®¡æŸ¥æ ‡å‡† */ + @ApiModelProperty("å®¡æŸ¥æ ‡å‡†") private String standard; /** * 审查è¦ç‚¹id */ + @ApiModelProperty("审查è¦ç‚¹id") private Long keypointId; /** * 审查è¦ç‚¹ */ + @ApiModelProperty("审查è¦ç‚¹") private String keypoint; /** * 审查细则id */ + @ApiModelProperty("审查细则id") private Long detailsId; /** * 审查细则 */ + @ApiModelProperty("审查细则") private String details; /** * æ“作(ADD DELETE UPDATE) */ + @ApiModelProperty(value = "æ“作" , notes = "[ADD DELETE UPDATE]") private String operation; /** * 当 operation 为 ADD æ—¶è¯¥å—æ®µä¸ºç©º */ + @ApiModelProperty(value = "场景旧值", notes = "当 operation 为 ADD æ—¶è¯¥å—æ®µä¸ºç©º") private String oldText; /** * 当 operation 为 DELETE æ—¶è¯¥å—æ®µä¸ºç©º */ + @ApiModelProperty(value = "场景新值", notes = "当 operation 为 DELETE æ—¶è¯¥å—æ®µä¸ºç©º") private String newText; /** * 备注 */ + @ApiModelProperty("备注") private String remark; /** @@ -65,6 +79,7 @@ public class ReviewSceneChangeTaskCreateRequest { * 若为修改ã€åˆ 除任务时,æ¤id在创建任务时赋值 * 若为新增任务时,æ¤id在审批通过并ä¿å˜æ–°åœºæ™¯åŽèµ‹å€¼ */ + @ApiModelProperty(value = "审查场景id", notes = "1.若为修改ã€åˆ 除任务时,æ¤id在创建任务时赋值; 2.若为新增任务时,æ¤id在审批通过并ä¿å˜æ–°åœºæ™¯åŽèµ‹å€¼ ") private Long reviewSceneId; } diff --git a/ruoyi-admin/src/main/resources/application.yml b/ruoyi-admin/src/main/resources/application.yml index b43a48e940280e85264945a35bfad4b869abc3b0..1d1e6a19314746384bd3880e366434073a5fbc86 100644 --- a/ruoyi-admin/src/main/resources/application.yml +++ b/ruoyi-admin/src/main/resources/application.yml @@ -134,7 +134,7 @@ swagger: # 是å¦å¼€å¯swagger enabled: true # 请求å‰ç¼€ - pathMapping: /dev-api + pathMapping: / # 防æ¢XSS攻击 xss: diff --git a/ruoyi-common/pom.xml b/ruoyi-common/pom.xml index e1cd5b988d7c5e66ac0ab661080f0c09138fb3be..fcacbca31e5666175dca91ee0ef866f53f05bdab 100644 --- a/ruoyi-common/pom.xml +++ b/ruoyi-common/pom.xml @@ -152,6 +152,12 @@ <version>8.2.1</version> </dependency> + <dependency> + <groupId>com.github.xiaoymin</groupId> + <artifactId>knife4j-spring-boot-starter</artifactId> + <version>3.0.3</version> + </dependency> + </dependencies> </project> \ No newline at end of file diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/controller/BaseController.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/controller/BaseController.java index c131bc47821c4ebbbeff18a8791649cd1d5a607d..8762f21ec2db419f9fa054968743859faea64155 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/core/controller/BaseController.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/controller/BaseController.java @@ -79,8 +79,7 @@ public class BaseController /** * å“åº”è¯·æ±‚åˆ†é¡µæ•°æ® */ - @SuppressWarnings({ "rawtypes", "unchecked" }) - protected TableDataInfo getDataTable(List<?> list) + protected <T> TableDataInfo<T> getDataTable(List<T> list) { TableDataInfo rspData = new TableDataInfo(); rspData.setCode(HttpStatus.SUCCESS); diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/AjaxResult.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/AjaxResult.java index 73b77e8428e38866c8a47e14563397859ee5948f..4515e0f2104112b329d06fd366503cb5d0927d7a 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/AjaxResult.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/AjaxResult.java @@ -1,7 +1,7 @@ package com.ruoyi.common.core.domain; -import java.util.HashMap; -import java.util.Objects; +import java.io.Serializable; + import com.ruoyi.common.constant.HttpStatus; import com.ruoyi.common.utils.StringUtils; @@ -10,19 +10,33 @@ import com.ruoyi.common.utils.StringUtils; * * @author ruoyi */ -public class AjaxResult extends HashMap<String, Object> +public class AjaxResult<T> implements Serializable { private static final long serialVersionUID = 1L; - /** 状æ€ç */ - public static final String CODE_TAG = "code"; - - /** 返回内容 */ - public static final String MSG_TAG = "msg"; - /** æ•°æ®å¯¹è±¡ */ public static final String DATA_TAG = "data"; + /** + * æ˜¯å¦æˆåŠŸ true or false + */ + private boolean success; + + /** + * 状æ€ç + */ + private int code; + + /** + * 返回内容 + */ + private String msg; + + /** + * æ•°æ®å¯¹è±¡ + */ + private T data; + /** * åˆå§‹åŒ–一个新创建的 AjaxResult 对象,使其表示一个空消æ¯ã€‚ */ @@ -32,36 +46,45 @@ public class AjaxResult extends HashMap<String, Object> /** * åˆå§‹åŒ–一个新创建的 AjaxResult 对象 - * - * @param code 状æ€ç + * + * @param code 错误ç * @param msg 返回内容 + * @param data æ•°æ®å¯¹è±¡ */ - public AjaxResult(int code, String msg) - { - super.put(CODE_TAG, code); - super.put(MSG_TAG, msg); + public AjaxResult(int code, String msg, T data) { + this.code = code; + this.msg = msg; + if (StringUtils.isNotNull(data)) { + this.data = data; + } + + if (code == HttpStatus.SUCCESS) { + this.success = Boolean.TRUE; + } else { + this.success = Boolean.FALSE; + } } /** * åˆå§‹åŒ–一个新创建的 AjaxResult 对象 - * - * @param code 状æ€ç + * + * @param code 错误ç * @param msg 返回内容 - * @param data æ•°æ®å¯¹è±¡ */ - public AjaxResult(int code, String msg, Object data) - { - super.put(CODE_TAG, code); - super.put(MSG_TAG, msg); - if (StringUtils.isNotNull(data)) - { - super.put(DATA_TAG, data); + public AjaxResult(int code, String msg) { + this.code = code; + this.msg = msg; + + if (code == HttpStatus.SUCCESS) { + this.success = Boolean.TRUE; + } else { + this.success = Boolean.FALSE; } } /** * 返回æˆåŠŸæ¶ˆæ¯ - * + * * @return æˆåŠŸæ¶ˆæ¯ */ public static AjaxResult success() @@ -71,17 +94,17 @@ public class AjaxResult extends HashMap<String, Object> /** * 返回æˆåŠŸæ•°æ® - * + * * @return æˆåŠŸæ¶ˆæ¯ */ - public static AjaxResult success(Object data) + public static <U> AjaxResult<U> success(U data) { return AjaxResult.success("æ“作æˆåŠŸ", data); } /** * 返回æˆåŠŸæ¶ˆæ¯ - * + * * @param msg 返回内容 * @return æˆåŠŸæ¶ˆæ¯ */ @@ -92,12 +115,12 @@ public class AjaxResult extends HashMap<String, Object> /** * 返回æˆåŠŸæ¶ˆæ¯ - * + * * @param msg 返回内容 * @param data æ•°æ®å¯¹è±¡ * @return æˆåŠŸæ¶ˆæ¯ */ - public static AjaxResult success(String msg, Object data) + public static <U> AjaxResult<U> success(String msg, U data) { return new AjaxResult(HttpStatus.SUCCESS, msg, data); } @@ -120,15 +143,15 @@ public class AjaxResult extends HashMap<String, Object> * @param data æ•°æ®å¯¹è±¡ * @return è¦å‘Šæ¶ˆæ¯ */ - public static AjaxResult warn(String msg, Object data) + public static <U> AjaxResult<U> warn(String msg, U data) { return new AjaxResult(HttpStatus.WARN, msg, data); } /** * è¿”å›žé”™è¯¯æ¶ˆæ¯ - * - * @return é”™è¯¯æ¶ˆæ¯ + * + * @return */ public static AjaxResult error() { @@ -137,9 +160,9 @@ public class AjaxResult extends HashMap<String, Object> /** * è¿”å›žé”™è¯¯æ¶ˆæ¯ - * + * * @param msg 返回内容 - * @return é”™è¯¯æ¶ˆæ¯ + * @return è¦å‘Šæ¶ˆæ¯ */ public static AjaxResult error(String msg) { @@ -148,70 +171,56 @@ public class AjaxResult extends HashMap<String, Object> /** * è¿”å›žé”™è¯¯æ¶ˆæ¯ - * + * * @param msg 返回内容 * @param data æ•°æ®å¯¹è±¡ - * @return é”™è¯¯æ¶ˆæ¯ + * @return è¦å‘Šæ¶ˆæ¯ */ - public static AjaxResult error(String msg, Object data) + public static <U> AjaxResult<U> error(String msg, U data) { return new AjaxResult(HttpStatus.ERROR, msg, data); } /** * è¿”å›žé”™è¯¯æ¶ˆæ¯ - * - * @param code 状æ€ç - * @param msg 返回内容 - * @return é”™è¯¯æ¶ˆæ¯ + * + * @param code å“应ç + * @param msg å“åº”æ¶ˆæ¯ + * @return è¦å‘Šæ¶ˆæ¯ */ - public static AjaxResult error(int code, String msg) + public static <U> AjaxResult<U> error(int code, String msg) { - return new AjaxResult(code, msg, null); + return new AjaxResult(code, msg); } /** - * 是å¦ä¸ºæˆåŠŸæ¶ˆæ¯ + * 方便链å¼è°ƒç”¨ * - * @return 结果 + * @param key é”® + * @param value 值 + * @return æ•°æ®å¯¹è±¡ */ - public boolean isSuccess() - { - return Objects.equals(HttpStatus.SUCCESS, this.get(CODE_TAG)); + @Deprecated + public AjaxResult put(String key, Object value) { + //super.put(key, value); + return this; } /** - * 是å¦ä¸ºè¦å‘Šæ¶ˆæ¯ + * 是å¦ä¸ºæˆåŠŸæ¶ˆæ¯ * * @return 结果 */ - public boolean isWarn() - { - return Objects.equals(HttpStatus.WARN, this.get(CODE_TAG)); + public boolean isSuccess() { + return success; } - /** - * 是å¦ä¸ºé”™è¯¯æ¶ˆæ¯ - * - * @return 结果 - */ - public boolean isError() - { - return Objects.equals(HttpStatus.ERROR, this.get(CODE_TAG)); + public String getMsg() { + return msg; } - /** - * 方便链å¼è°ƒç”¨ - * - * @param key é”® - * @param value 值 - * @return æ•°æ®å¯¹è±¡ - */ - @Override - public AjaxResult put(String key, Object value) - { - super.put(key, value); - return this; + public Integer getCode() { + return code; } } diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/page/TableDataInfo.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/TableDataInfo.java index 04af10a5c629174f0fb45ae5c89c7f046da71965..937b39de10166eb2d67040a2c476454058d36042 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/core/page/TableDataInfo.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/page/TableDataInfo.java @@ -8,76 +8,63 @@ import java.util.List; * * @author ruoyi */ -public class TableDataInfo implements Serializable +public class TableDataInfo<T> implements Serializable { private static final long serialVersionUID = 1L; /** 总记录数 */ private long total; - /** åˆ—è¡¨æ•°æ® */ - private List<?> rows; - + private List<T> rows; /** 消æ¯çжæ€ç */ private int code; - /** 消æ¯å†…容 */ private String msg; - /** * è¡¨æ ¼æ•°æ®å¯¹è±¡ */ public TableDataInfo() { } - /** * 分页 - * + * * @param list åˆ—è¡¨æ•°æ® * @param total 总记录数 */ - public TableDataInfo(List<?> list, int total) + public TableDataInfo(List<T> list, int total) { this.rows = list; this.total = total; } - public long getTotal() { return total; } - public void setTotal(long total) { this.total = total; } - - public List<?> getRows() + public List<T> getRows() { return rows; } - - public void setRows(List<?> rows) + public void setRows(List<T> rows) { this.rows = rows; } - public int getCode() { return code; } - public void setCode(int code) { this.code = code; } - public String getMsg() { return msg; } - public void setMsg(String msg) { this.msg = msg;