浏览代码

外部报验swagger注解

wangming 1 年之前
父节点
当前提交
27b73b334a

+ 15 - 0
business-entity/src/main/java/com/rongwei/bsentity/vo/OperOutsideInspectionVo.java

@@ -1,10 +1,13 @@
 package com.rongwei.bsentity.vo;
 package com.rongwei.bsentity.vo;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 import java.util.Date;
 import java.util.Date;
 
 
 @Data
 @Data
+@ApiModel("操作参数")
 public class OperOutsideInspectionVo {
 public class OperOutsideInspectionVo {
     /**
     /**
      * 10: 取消
      * 10: 取消
@@ -14,21 +17,25 @@ public class OperOutsideInspectionVo {
      * 50: 接收
      * 50: 接收
      * 60: 有条件接收
      * 60: 有条件接收
      * */
      * */
+    @ApiModelProperty("操作类型")
     private String operType;
     private String operType;
 
 
     /**
     /**
      * ZHCX_OUTSIDE_INSPECTION_ITP表主键
      * ZHCX_OUTSIDE_INSPECTION_ITP表主键
      * */
      * */
+    @ApiModelProperty("外部报验id")
     private String itpId;
     private String itpId;
 
 
     /**
     /**
      * ZHCX_OUTSIDE_INSPECTION_ITP_SUPERVISION_DISPATCH表主键
      * ZHCX_OUTSIDE_INSPECTION_ITP_SUPERVISION_DISPATCH表主键
      * */
      * */
+    @ApiModelProperty("外部报验派单id")
     private String dispatchId;
     private String dispatchId;
 
 
     /**
     /**
      * 取消/拒收原因
      * 取消/拒收原因
      *  */
      *  */
+    @ApiModelProperty("补充说明")
     private String reason;
     private String reason;
 
 
     /**
     /**
@@ -36,34 +43,41 @@ public class OperOutsideInspectionVo {
      * 20: 监理主管
      * 20: 监理主管
      * 30: 监理检验员
      * 30: 监理检验员
      * */
      * */
+    @ApiModelProperty("操作人类型")
     private String source;
     private String source;
 
 
     /**
     /**
      * 派单/转派的监理对象
      * 派单/转派的监理对象
      * */
      * */
+    @ApiModelProperty("监理用户信息")
     private SupervisionVo supervisionVo;
     private SupervisionVo supervisionVo;
 
 
     /**
     /**
      * 开始时间
      * 开始时间
      * */
      * */
+    @ApiModelProperty("检验开始时间")
     private Date startDate;
     private Date startDate;
 
 
     /**
     /**
      * 结束时间
      * 结束时间
      */
      */
+    @ApiModelProperty("监理结束时间")
     private Date endDate;
     private Date endDate;
 
 
     /**
     /**
      * 附件
      * 附件
      */
      */
+    @ApiModelProperty("附件")
     private String files;
     private String files;
     /**
     /**
      * 画布
      * 画布
      */
      */
+    @ApiModelProperty("画布")
     private String canvas;
     private String canvas;
     /**
     /**
      * 签名
      * 签名
      */
      */
+    @ApiModelProperty("签名")
     private String signature;
     private String signature;
     /**
     /**
      *
      *
@@ -73,5 +87,6 @@ public class OperOutsideInspectionVo {
      *
      *
      * 页面类型
      * 页面类型
      */
      */
+    @ApiModelProperty("操作页面")
     private String pageType;
     private String pageType;
 }
 }

+ 8 - 0
business-entity/src/main/java/com/rongwei/bsentity/vo/SupervisionVo.java

@@ -1,28 +1,36 @@
 package com.rongwei.bsentity.vo;
 package com.rongwei.bsentity.vo;
 
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 @Data
 @Data
+@ApiModel("监理用户参数")
 public class SupervisionVo {
 public class SupervisionVo {
     /**
     /**
      * 监理用户表主键id
      * 监理用户表主键id
      */
      */
+    @ApiModelProperty("监理用户id")
     private String id;
     private String id;
     /**
     /**
      * 监理用户名称
      * 监理用户名称
      */
      */
+    @ApiModelProperty("监理用户名称")
     private String name;
     private String name;
     /**
     /**
      * 监理用户手机号
      * 监理用户手机号
      */
      */
+    @ApiModelProperty("监理用户手机号")
     private String phone;
     private String phone;
     /**
     /**
      * 监理用户账号
      * 监理用户账号
      */
      */
+    @ApiModelProperty("监理用户账号")
     private String account;
     private String account;
 
 
     /**
     /**
      * 建立用户userid(用户表id)
      * 建立用户userid(用户表id)
      */
      */
+    @ApiModelProperty("监理用户userid")
     private String supervisionuserid;
     private String supervisionuserid;
 }
 }

+ 5 - 0
business-entity/src/main/java/com/rongwei/bsentity/vo/ZhcxOutsideExportVo.java

@@ -1,15 +1,20 @@
 package com.rongwei.bsentity.vo;
 package com.rongwei.bsentity.vo;
 
 
 import com.rongwei.rwcommoncomponent.excel.aspose.ExcelFormData;
 import com.rongwei.rwcommoncomponent.excel.aspose.ExcelFormData;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.Data;
 
 
 /**
 /**
  * @author zhuang
  * @author zhuang
  */
  */
 @Data
 @Data
+@ApiModel
 public class ZhcxOutsideExportVo {
 public class ZhcxOutsideExportVo {
 
 
+    @ApiModelProperty("外部报验id")
     private String itpid;
     private String itpid;
 
 
+    @ApiModelProperty("表单配置")
     private ExcelFormData excelData;
     private ExcelFormData excelData;
 }
 }

+ 5 - 0
business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxOperOutsideInspectionController.java

@@ -7,6 +7,8 @@ import com.rongwei.bsentity.vo.OperOutsideInspectionVo;
 import com.rongwei.bsentity.vo.ZhcxOutsideExportVo;
 import com.rongwei.bsentity.vo.ZhcxOutsideExportVo;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommon.base.exception.CustomException;
 import com.rongwei.rwcommon.base.exception.CustomException;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -22,12 +24,14 @@ import java.util.Map;
 @RestController
 @RestController
 @RequestMapping("/zhcxOperOutsideInspection")
 @RequestMapping("/zhcxOperOutsideInspection")
 @Slf4j
 @Slf4j
+@Api("外部报验参数")
 public class ZhcxOperOutsideInspectionController {
 public class ZhcxOperOutsideInspectionController {
     @Autowired
     @Autowired
     private ZhcxOutsideInspectionItpService inspectionService;
     private ZhcxOutsideInspectionItpService inspectionService;
     @Autowired
     @Autowired
     private LockUtils lockUtils;
     private LockUtils lockUtils;
 
 
+    @ApiOperation("外部报验操作")
     @PostMapping("/OperInspectionStatus")
     @PostMapping("/OperInspectionStatus")
     public R OperInspectionStatus(@RequestBody List<OperOutsideInspectionVo> vo) {
     public R OperInspectionStatus(@RequestBody List<OperOutsideInspectionVo> vo) {
         try {
         try {
@@ -48,6 +52,7 @@ public class ZhcxOperOutsideInspectionController {
         }
         }
     }
     }
 
 
+    @ApiOperation("文件下载")
     @PostMapping("/downloadFile")
     @PostMapping("/downloadFile")
     public void downloadFile(@RequestBody ZhcxOutsideExportVo zhcxOutsideExportVo, HttpServletResponse response) throws FileNotFoundException {
     public void downloadFile(@RequestBody ZhcxOutsideExportVo zhcxOutsideExportVo, HttpServletResponse response) throws FileNotFoundException {
         int i = inspectionService.downloadFile(zhcxOutsideExportVo, response);
         int i = inspectionService.downloadFile(zhcxOutsideExportVo, response);