内部报验swagger注解

business-entity/src/main/java/com/rongwei/bsentity/dto/InsideInspectionOperBaseDto.java

@@ -1,5 +1,8 @@
 package com.rongwei.bsentity.dto;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -12,11 +15,13 @@ import java.util.List;
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("内部报验操作基础参数")
 public class InsideInspectionOperBaseDto implements Serializable {
 
     /**
      * 内部报验单id
      */
+    @ApiModelProperty("内部报验id")
     private List<String> insideIdList;
 
     /**
@@ -25,5 +30,6 @@ public class InsideInspectionOperBaseDto implements Serializable {
      * pc
      * mobile
      */
+    @ApiModelProperty("发起源：pc、mobile")
     private String launchSource;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/InsideInspectionOperRequest.java

@@ -1,5 +1,7 @@
 package com.rongwei.bsentity.dto;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Setter
@@ -7,11 +9,13 @@ import lombok.*;
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
+@ApiModel
 public class InsideInspectionOperRequest {
 
     /**
      * 内部报验单id
      */
+    @ApiModelProperty("内部报验id")
     private String id;
 
     /**
@@ -20,5 +24,6 @@ public class InsideInspectionOperRequest {
      * pc
      * mobile
      */
+    @ApiModelProperty("发起源：pc、mobile")
     private String launchSource;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionDispatchRequest.java

@@ -1,5 +1,6 @@
 package com.rongwei.bsentity.dto.inside;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -14,6 +15,7 @@ public class InsideInspectionDispatchRequest extends InsideInspectionExecuteRequ
     /**
      * 检验员id
      */
+    @ApiModelProperty("被指派检验员id")
     private String supervisionId;
 
     /**
@@ -21,5 +23,6 @@ public class InsideInspectionDispatchRequest extends InsideInspectionExecuteRequ
      * 1、表示派单
      * 2、表示改单
      */
+    @ApiModelProperty(hidden = true)
     private Integer dispatchFlag;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionExecuteRequest.java

@@ -2,6 +2,8 @@ package com.rongwei.bsentity.dto.inside;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.rongwei.bsentity.dto.InsideInspectionOperBaseDto;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -14,6 +16,7 @@ import java.util.Date;
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("派单参数")
 public class InsideInspectionExecuteRequest extends InsideInspectionOperBaseDto {
 
     /**
@@ -22,16 +25,19 @@ public class InsideInspectionExecuteRequest extends InsideInspectionOperBaseDto
      * 20：拒收
      * 30：有条件接收
      */
+    @ApiModelProperty("报验结论")
     private String conclusion;
 
     /**
      * 签名
      */
+    @ApiModelProperty("签名")
     private String signature;
 
     /**
      * 补充说明
      */
+    @ApiModelProperty("补充说明")
     private String reason;
 
 
@@ -40,6 +46,7 @@ public class InsideInspectionExecuteRequest extends InsideInspectionOperBaseDto
      * */
     @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty("检验开始时间")
     private Date startDate;
 
     /**
@@ -47,14 +54,17 @@ public class InsideInspectionExecuteRequest extends InsideInspectionOperBaseDto
      */
     @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty("检验结束时间")
     private Date endDate;
 
     /**
      * 附件
      */
+    @ApiModelProperty("画布")
     private String files;
     /**
      * 画布
      */
+    @ApiModelProperty("画布")
     private String canvas;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionInsertRequest.java

@@ -2,16 +2,20 @@ package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.bsentity.dto.InsideInspectionOperRequest;
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveInsertVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Setter
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("保存参数")
 public class InsideInspectionInsertRequest extends InsideInspectionOperRequest {
 
     /**
      * 保存数据
      */
+    @ApiModelProperty("保存数据")
     private MasterSlaveInsertVo insert;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionModifyRecordRequest.java

@@ -1,7 +1,8 @@
 package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.bsentity.dto.InsideInspectionOperBaseDto;
-import com.rongwei.rwcommon.vo.generalsql.MasterSlaveUpdateVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -13,11 +14,13 @@ import java.util.Map;
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("添加修改记录参数")
 public class InsideInspectionModifyRecordRequest extends InsideInspectionOperBaseDto {
 
     /**
      * 保存数据
      * value，新的表单数据
      */
+    @ApiModelProperty("保存数据")
     private Map<String, Map<String,Object>> map;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionReInspectionRequest.java

@@ -2,6 +2,8 @@ package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.bsentity.dto.InsideInspectionOperBaseDto;
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveUpdateVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -13,10 +15,12 @@ import java.util.Map;
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("重新报验参数")
 public class InsideInspectionReInspectionRequest extends InsideInspectionOperBaseDto {
 
     /**
      * 保存数据
      */
+    @ApiModelProperty("重新报验数据")
     private Map<String, MasterSlaveUpdateVo> map;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionRequest.java

@@ -1,6 +1,7 @@
 package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.bsentity.dto.InsideInspectionOperBaseDto;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -15,6 +16,7 @@ public class InsideInspectionRequest extends InsideInspectionOperBaseDto {
     /**
      * 补充说明
      */
+    @ApiModelProperty("补充说明")
     private String reason;
 
     /**
@@ -23,5 +25,6 @@ public class InsideInspectionRequest extends InsideInspectionOperBaseDto {
      *
      * 页面类型
      */
+    @ApiModelProperty("页面类型")
     private String pageType;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/InsideInspectionUpdateRequest.java

@@ -2,17 +2,21 @@ package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.bsentity.dto.InsideInspectionOperRequest;
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveUpdateVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Setter
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("修改参数")
 public class InsideInspectionUpdateRequest extends InsideInspectionOperRequest {
 
     /**
      * 保存数据
      */
+    @ApiModelProperty("修改数据")
     private MasterSlaveUpdateVo update;
 
     /**
@@ -20,5 +24,6 @@ public class InsideInspectionUpdateRequest extends InsideInspectionOperRequest {
      * reInspection 重新报验
      * updateInspection 修改
      */
+    @ApiModelProperty("操作类型")
     private String operType;
 }

business-entity/src/main/java/com/rongwei/bsentity/dto/inside/ZhcxInsideExportRequest.java

@@ -1,6 +1,8 @@
 package com.rongwei.bsentity.dto.inside;
 
 import com.rongwei.rwcommoncomponent.excel.aspose.ExcelFormData;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -10,9 +12,12 @@ import lombok.Setter;
 @Getter
 @NoArgsConstructor
 @AllArgsConstructor
+@ApiModel("下载请求参数")
 public class ZhcxInsideExportRequest {
 
+    @ApiModelProperty("内部报验id")
     private String insideId;
 
+    @ApiModelProperty("表单配置")
     private ExcelFormData excelData;
 }

business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxInsideInspectionController.java

@@ -6,6 +6,9 @@ import com.rongwei.bsentity.dto.InsideInspectionOperRequest;
 import com.rongwei.bsentity.dto.inside.*;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommon.base.exception.CustomException;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -24,6 +27,7 @@ import javax.servlet.http.HttpServletResponse;
  */
 @RestController
 @RequestMapping("/inside/inspection")
+@Api(tags = "内部报验")
 public class ZhcxInsideInspectionController {
 
     @Autowired
@@ -35,6 +39,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("发起报验")
     @PostMapping("/launch")
     public R launch(@RequestBody InsideInspectionOperRequest req){
         service.launch(req);
@@ -48,6 +53,7 @@ public class ZhcxInsideInspectionController {
      * @return
      */
     @PostMapping("/dispacth")
+    @ApiOperation("派单")
     public R dispacth(@RequestBody InsideInspectionDispatchRequest req){
         req.setDispatchFlag(1);
         service.dispatch(req);
@@ -60,6 +66,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("改派")
     @PostMapping("/reDispatch")
     public R reDispatch(@RequestBody InsideInspectionDispatchRequest req){
         req.setDispatchFlag(2);
@@ -73,6 +80,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("执行")
     @PostMapping("/execute")
     public R execute(@RequestBody InsideInspectionDispatchRequest req){
         service.execute(req);
@@ -85,6 +93,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("取消")
     @PostMapping("/cancel")
     public R cancel(@RequestBody InsideInspectionRequest req){
         service.cancel(req);
@@ -97,6 +106,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("重新报验")
     @PostMapping("/reInspection")
     public R reInspection(@RequestBody InsideInspectionReInspectionRequest req){
         service.reInspection(req);
@@ -104,11 +114,12 @@ public class ZhcxInsideInspectionController {
     }
 
     /**
-     * 重新报验
+     * 添加修改记录
      *
      * @param req
      * @return
      */
+    @ApiOperation("添加修改记录")
     @PostMapping("/addModifyHistory")
     public R addModifyHistory(@RequestBody InsideInspectionModifyRecordRequest req){
         service.addModifyHistory(req);
@@ -121,6 +132,7 @@ public class ZhcxInsideInspectionController {
      * @param exportReq
      * @param response
      */
+    @ApiOperation("文件下载")
     @PostMapping("/downloadFile")
     public void downloadFile(@RequestBody ZhcxInsideExportRequest exportReq, HttpServletResponse response) {
         int i = service.downloadFile(exportReq, response);
@@ -137,6 +149,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("保存内部报验")
     @PostMapping("/insertInspection")
     public R insertInspection(@RequestBody InsideInspectionInsertRequest req){
         service.insertInspection(req);
@@ -149,6 +162,7 @@ public class ZhcxInsideInspectionController {
      * @param req
      * @return
      */
+    @ApiOperation("修改内部报验")
     @PostMapping("/updateInspection")
     public R updateInspection(@RequestBody InsideInspectionUpdateRequest req){
         service.updateInspection(req);