Feat

1、新增swagger注解。

Reference N/A

quality-review/src/main/java/com/ruoyi/domain/ReviewDetails.java

@@ -4,6 +4,8 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.List;
@@ -11,6 +13,7 @@ import java.util.List;
 /**
  * 审查细则
  */
+@ApiModel
 @TableName(value ="t_review_details")
 @Data
 public class ReviewDetails {
@@ -18,28 +21,33 @@ public class ReviewDetails {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 文本内容
      */
+    @ApiModelProperty("文本内容")
     private String text;
 
     /**
      * 审查要点id
      */
+    @ApiModelProperty("审查要点id")
     private Long reviewKeypointId;
 
     /**
      * 审核场景列表
      */
+    @ApiModelProperty("审核场景列表")
     @TableField(exist = false)
     private List<ReviewScene> reviewSceneList;
 
     /**
      * 该明细的审查结果
      */
+    @ApiModelProperty("该明细的审查结果")
     @TableField(exist = false)
     private ReviewDetailsResult result;
 

quality-review/src/main/java/com/ruoyi/domain/ReviewDetailsResult.java

@@ -4,44 +4,54 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import java.io.Serializable;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
  * 审查细则的审查结果
  * @TableName t_review_details_result
  */
+@ApiModel
 @TableName(value ="t_review_details_result")
 @Data
 public class ReviewDetailsResult implements Serializable {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 审核是否通过（0未通过、1通过）
      */
+    @ApiModelProperty("审核是否通过（0未通过、1通过）")
     private Integer passed;
 
     /**
      * 评论
      */
+    @ApiModelProperty("评论")
     private String comment;
 
     /**
      * 厂商适用于该细则的场景截图或照片（多个url用","分隔）
      */
+    @ApiModelProperty("厂商适用于该细则的场景截图或照片（多个url用\",\"分隔）")
     private String imagesUrl;
 
     /**
      * 关联到的细则id
      */
+    @ApiModelProperty("关联到的细则id")
     private Long reviewDetailsId;
 
     /**
      * 关联的任务id
      */
+    @ApiModelProperty("关联的任务id")
     private Long taskId;
 
 }
\ No newline at end of file

quality-review/src/main/java/com/ruoyi/domain/ReviewKeyPoint.java

@@ -4,6 +4,8 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.List;
@@ -11,6 +13,7 @@ import java.util.List;
 /**
  * 审查要点
  */
+@ApiModel
 @TableName(value ="t_review_keypoint")
 @Data
 public class ReviewKeyPoint {
@@ -18,22 +21,26 @@ public class ReviewKeyPoint {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 文本内容
      */
+    @ApiModelProperty("文本内容")
     private String text;
 
     /**
      * 审查标准id
      */
+    @ApiModelProperty("审查标准id")
     private Long reviewStandardId;
 
     /**
      * 审查细则列表
      */
+    @ApiModelProperty("审查细则列表")
     @TableField(exist = false)
     private List<ReviewDetails> reviewDetailsList;
 

quality-review/src/main/java/com/ruoyi/domain/ReviewScene.java

@@ -3,12 +3,15 @@ package com.ruoyi.domain;
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.experimental.Accessors;
 
 /**
  * 审查场景
  */
+@ApiModel
 @TableName(value ="t_review_scene")
 @Accessors(chain = true)
 @Data
@@ -17,17 +20,20 @@ public class ReviewScene {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 文本内容
      */
+    @ApiModelProperty("文本内容")
     private String text;
 
     /**
      * 审查细则id
      */
+    @ApiModelProperty("审查细则id")
     private Long reviewDetailsId;
 
 }

quality-review/src/main/java/com/ruoyi/domain/ReviewSceneChangeTaskUserRelation.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_user_relation
  */
+@ApiModel
 @TableName(value ="t_review_scene_change_task_user_relation")
 @Accessors(chain = true)
 @Data
@@ -25,42 +29,50 @@ public class ReviewSceneChangeTaskUserRelation {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 任务id
      */
+    @ApiModelProperty("任务id")
     private Long taskId;
 
     /**
      * 用户id
      */
+    @ApiModelProperty("用户id")
     private Long userId;
 
     /**
      * 审核意见（PASS、REJECT）
      */
+    @ApiModelProperty("审核意见（PASS、REJECT）")
     private String decision;
 
     /**
      * 评论
      */
+    @ApiModelProperty("评论")
     private String comment;
 
     /**
      * 审核时间
      */
+    @ApiModelProperty("审核时间")
     private Date decisionTime;
 
     /**
      * 用户姓名
      */
+    @ApiModelProperty("用户姓名")
     private String name;
 
     /**
      * 部门名称
      */
+    @ApiModelProperty("部门名称")
     private String dept;
 
 }
\ No newline at end of file

quality-review/src/main/java/com/ruoyi/domain/ReviewStandard.java

@@ -4,6 +4,8 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.List;
@@ -11,6 +13,7 @@ import java.util.List;
 /**
  * 审查标准
  */
+@ApiModel
 @TableName(value ="t_review_standard")
 @Data
 public class ReviewStandard {
@@ -18,23 +21,27 @@ public class ReviewStandard {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 章节
      */
+    @ApiModelProperty("章节")
     private String chapter;
 
 
     /**
      * 文本内容
      */
+    @ApiModelProperty("文本内容")
     private String text;
 
     /**
      * 要点列表
      */
+    @ApiModelProperty("要点列表")
     @TableField(exist = false)
     private List<ReviewKeyPoint> keyPointList;
 

quality-review/src/main/java/com/ruoyi/domain/SystemReviewTask.java

@@ -8,6 +8,8 @@ import java.util.Date;
 import java.util.List;
 
 import com.ruoyi.common.StandardJsonTypeHandler;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.experimental.Accessors;
 
@@ -15,6 +17,7 @@ import lombok.experimental.Accessors;
  * 体系审查任务
  * @TableName t_system_review_task
  */
+@ApiModel
 @TableName(value ="t_system_review_task", autoResultMap = true)
 @Accessors(chain = true)
 @Data
@@ -33,68 +36,81 @@ public class SystemReviewTask {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 任务编号
      */
+    @ApiModelProperty("任务编号")
     private String taskNo;
 
     /**
      * 任务状态（NEW、PENDING、FINISH、CLOSE）
      */
+    @ApiModelProperty("任务状态（NEW、PENDING、FINISH、CLOSE）")
     private String taskStatus;
 
     /**
      * 任务发起人姓名
      */
+    @ApiModelProperty("任务发起人姓名")
     private String taskInitiator;
 
     /**
      * 任务发起人部门
      */
+    @ApiModelProperty("任务发起人部门")
     private String taskInitiatorDept;
 
     /**
      * 任务结果（PASS、REJECT）
      */
+    @ApiModelProperty("任务结果（PASS、REJECT）")
     private String taskResult;
 
     /**
      * 任务开始时间
      */
+    @ApiModelProperty("任务开始时间")
     private Date taskBeginTime;
 
     /**
      * 任务结束时间
      */
+    @ApiModelProperty("任务结束时间")
     private Date taskEndTime;
 
     /**
      * 审查标准
      */
+    @ApiModelProperty("审查标准")
     @TableField(value="standard", typeHandler = StandardJsonTypeHandler. class)
     private List<ReviewStandard> standard;
 
     /**
      * 占位（开发人员根据具体业务自行增加业务字段）
      */
+    @ApiModelProperty("占位（开发人员根据具体业务自行增加业务字段）")
     private String bizInfo;
 
     /**
      * 审核组长id
      */
+    @ApiModelProperty("审核组长id")
     private Long leaderId;
 
     /**
      * 审核组长姓名
      */
+    @ApiModelProperty("审核组长姓名")
     private String leader;
 
     /**
      * 创建时间
      */
+    @ApiModelProperty("创建时间")
     private Date createTime;
 
 }
\ No newline at end of file

quality-review/src/main/java/com/ruoyi/domain/SystemReviewTaskInbox.java

@@ -3,6 +3,8 @@ package com.ruoyi.domain;
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.experimental.Accessors;
 
@@ -10,6 +12,7 @@ import lombok.experimental.Accessors;
  * 体系审查任务收件箱（目前用来获取审查场景变更通知）
  * @TableName t_system_review_task_inbox
  */
+@ApiModel
 @TableName(value ="t_system_review_task_inbox")
 @Accessors(chain = true)
 @Data
@@ -17,22 +20,26 @@ public class SystemReviewTaskInbox {
     /**
      * 主键
      */
+    @ApiModelProperty("主键")
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
     /**
      * 体系审查任务id
      */
+    @ApiModelProperty("体系审查任务id")
     private Long systemReviewTaskId;
 
     /**
      * 场景变更任务id
      */
+    @ApiModelProperty("场景变更任务id")
     private Long reviewSceneChangeTaskId;
 
     /**
      * 该消息是否已确认(0未确认:1已确认)
      */
+    @ApiModelProperty("该消息是否已确认(0未确认:1已确认)")
     private Integer isConfirm;
 
 }
\ No newline at end of file

quality-review/src/main/java/com/ruoyi/domain/SystemReviewTaskUserRelation.java

@@ -4,6 +4,8 @@ import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.experimental.Accessors;
 
@@ -11,6 +13,7 @@ import lombok.experimental.Accessors;
  * 体系审查任务&用户映射关系
  * @TableName t_system_review_task_user_relation
  */
+@ApiModel
 @TableName(value ="t_system_review_task_user_relation")
 @Accessors(chain = true)
 @Data
@@ -19,22 +22,26 @@ public class SystemReviewTaskUserRelation {
     /**
      * 任务id
      */
+    @ApiModelProperty("任务id")
     @TableId(type = IdType.ASSIGN_ID)
     private Long taskId;
 
     /**
      * 用户id
      */
+    @ApiModelProperty("用户id")
     private Long userId;
 
     /**
      * 是否是组长（1是、0不是）
      */
+    @ApiModelProperty("是否是组长（1是、0不是）")
     private Integer isLeader;
 
     /**
      * 用户姓名
      */
+    @ApiModelProperty("用户姓名")
     private String name;
 
 }
\ No newline at end of file

quality-review/src/main/java/com/ruoyi/web/SystemReviewTaskController.java

@@ -3,12 +3,15 @@ package com.ruoyi.web;
 import com.ruoyi.common.annotation.Log;
 import com.ruoyi.common.core.controller.BaseController;
 import com.ruoyi.common.core.domain.AjaxResult;
+import com.ruoyi.common.core.domain.R;
 import com.ruoyi.common.enums.BusinessType;
 import com.ruoyi.service.SystemReviewTaskService;
 import com.ruoyi.web.request.SystemReviewTaskCreateRequest;
 import com.ruoyi.web.request.SystemReviewTaskStartRequest;
 import com.ruoyi.web.request.SystemReviewTaskViewRequest;
 import com.ruoyi.web.response.SystemReviewTaskViewResponse;
+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;
@@ -19,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("/system/review/task")
 public class SystemReviewTaskController extends BaseController {
@@ -26,28 +30,31 @@ public class SystemReviewTaskController extends BaseController {
     @Autowired
     private SystemReviewTaskService systemReviewTaskService;
 
+    @ApiOperation("创建体系审查任务")
     @Trace
     @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")})
     @Log(title = "体系审查任务", businessType = BusinessType.INSERT)
     @RequestMapping(method = RequestMethod.POST, value = "/create")
-    public AjaxResult create(@Validated @RequestBody SystemReviewTaskCreateRequest request) {
+    public R<String> create(@Validated @RequestBody SystemReviewTaskCreateRequest request) {
         systemReviewTaskService.createTaskTest(request);
-        return success();
+        return R.ok();
     }
 
+    @ApiOperation("查看体系审查任务详情")
     @Trace
     @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")})
     @RequestMapping(method = RequestMethod.POST, value = "/view")
-    public AjaxResult view(@Validated @RequestBody SystemReviewTaskViewRequest request) {
+    public R<SystemReviewTaskViewResponse> view(@Validated @RequestBody SystemReviewTaskViewRequest request) {
         SystemReviewTaskViewResponse systemReviewTaskViewResponse = systemReviewTaskService.view(request.getTaskId());
-        return AjaxResult.success(systemReviewTaskViewResponse);
+        return R.ok(systemReviewTaskViewResponse);
     }
 
+    @ApiOperation("启动体系审查任务")
     @Trace
     @Tags({@Tag(key = "param", value = "arg[0]"), @Tag(key = "result", value = "returnedObj")})
     @RequestMapping(method = RequestMethod.POST, value = "/start")
-    public AjaxResult start(@Validated @RequestBody SystemReviewTaskStartRequest request) {
+    public R<String> start(@Validated @RequestBody SystemReviewTaskStartRequest request) {
         systemReviewTaskService.start(request);
-        return AjaxResult.success();
+        return R.ok();
     }
 }

quality-review/src/main/java/com/ruoyi/web/response/SystemReviewTaskViewResponse.java

@@ -2,21 +2,26 @@ package com.ruoyi.web.response;
 
 import com.ruoyi.domain.ReviewSceneChangeTask;
 import com.ruoyi.domain.SystemReviewTask;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.List;
 
+@ApiModel(value = "SystemReviewTaskViewResponse", description = "查询体系审查任务详情响应体")
 @Data
 public class SystemReviewTaskViewResponse {
 
     /**
      * 任务信息
      */
+    @ApiModelProperty("任务信息")
     private SystemReviewTask systemReviewTask;
 
     /**
      * 任务开始后的场景变更信息
      */
+    @ApiModelProperty("任务开始后的场景变更信息")
     private List<ReviewSceneChangeTask> reviewSceneChangeTasks;
 
 }