Browse Source

外部报验swagger注解

wangming 1 year ago
parent
commit
aaea17a3e9

+ 8 - 0
business-entity/src/main/java/com/rongwei/bsentity/dto/OutsideInspactionSyncReqquest.java

@@ -1,8 +1,12 @@
 package com.rongwei.bsentity.dto;
 
 import com.fasterxml.jackson.annotation.JsonFormat;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import jdk.nashorn.internal.ir.annotations.Ignore;
 import lombok.*;
 import org.springframework.format.annotation.DateTimeFormat;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.Date;
 import java.util.List;
@@ -12,6 +16,7 @@ import java.util.List;
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
+@ApiModel("同步过滤数据参数")
 public class OutsideInspactionSyncReqquest {
 
     /**
@@ -19,6 +24,7 @@ public class OutsideInspactionSyncReqquest {
      */
     @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty(hidden = true)
     private Date startTime;
 
     /**
@@ -26,10 +32,12 @@ public class OutsideInspactionSyncReqquest {
      */
     @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty(hidden = true)
     private Date endTime;
 
     /**
      * 外部报验单id
      */
+    @ApiModelProperty("外部报验单id")
     private List<String> outesideIdList;
 }

+ 5 - 0
business-entity/src/main/java/com/rongwei/bsentity/dto/ReInspectionRequest.java

@@ -1,10 +1,15 @@
 package com.rongwei.bsentity.dto;
 
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveUpdateVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 @Data
+@ApiModel("请求参数")
 public class ReInspectionRequest {
+    @ApiModelProperty("外部报验数据")
     private MasterSlaveUpdateVo masterSlaveUpdate;
+    @ApiModelProperty("外部报验id")
     private String id;
 }

+ 5 - 0
business-entity/src/main/java/com/rongwei/bsentity/dto/outside/OutsideInspectionInsertRequest.java

@@ -1,6 +1,8 @@
 package com.rongwei.bsentity.dto.outside;
 
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveInsertVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Setter
@@ -8,15 +10,18 @@ import lombok.*;
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
+@ApiModel
 public class OutsideInspectionInsertRequest {
 
     /**
      * 报验单id
      */
+    @ApiModelProperty("外部报验单id")
     private String id;
 
     /**
      * 保存数据
      */
+    @ApiModelProperty("外部报验单保存数据")
     private MasterSlaveInsertVo insert;
 }

+ 6 - 0
business-entity/src/main/java/com/rongwei/bsentity/dto/outside/OutsideInspectionUpdateRequest.java

@@ -1,6 +1,8 @@
 package com.rongwei.bsentity.dto.outside;
 
 import com.rongwei.rwcommon.vo.generalsql.MasterSlaveUpdateVo;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Setter
@@ -8,16 +10,19 @@ import lombok.*;
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
+@ApiModel
 public class OutsideInspectionUpdateRequest {
 
     /**
      * 报验单id
      */
+    @ApiModelProperty("报验单id")
     private String id;
 
     /**
      * 保存数据
      */
+    @ApiModelProperty("保存数据")
     private MasterSlaveUpdateVo update;
 
     /**
@@ -25,5 +30,6 @@ public class OutsideInspectionUpdateRequest {
      * reInspection 重新报验
      * updateInspection 修改
      */
+    @ApiModelProperty("操作类型")
     private String operType;
 }

+ 17 - 1
business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxOutsideInspectionItpController.java

@@ -8,11 +8,16 @@ import com.rongwei.bsentity.dto.ReInspectionRequest;
 import com.rongwei.bsentity.dto.outside.OutsideInspectionInsertRequest;
 import com.rongwei.bsentity.dto.outside.OutsideInspectionUpdateRequest;
 import com.rongwei.rwcommon.base.R;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+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;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.Map;
 
@@ -26,6 +31,7 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/zhcxOutsideInspectionItp")
+@Api(tags = "外部报验")
 public class ZhcxOutsideInspectionItpController {
 
     @Autowired
@@ -34,12 +40,17 @@ public class ZhcxOutsideInspectionItpController {
     @Autowired
     private ZhcxReprotSameDayRealTimeInspectionStatisticsService reprotSameDayRealTimeInspectionStatisticsService;
 
+    @ApiOperation("发起报验")
+    @ApiImplicitParams(value = {
+            @ApiImplicitParam(name = "id", value = "外部报验id")
+    })
     @PostMapping("/splitOrder")
-    public R copyNodesSave(@RequestBody Map<String, String> map){
+    public R copyNodesSave(@RequestBody @ApiIgnore Map<String, String> map){
         service.splitOrder(map.get("id"));
         return R.ok();
     }
 
+    @ApiOperation("重新报验")
     @PostMapping("/reInspection")
     public R reInspection(@RequestBody ReInspectionRequest res){
         service.reInspection(res.getId(), res.getMasterSlaveUpdate());
@@ -52,6 +63,7 @@ public class ZhcxOutsideInspectionItpController {
      * @param res
      * @return
      */
+    @ApiOperation("生成修改记录")
     @PostMapping("/genModifyRecord")
     public R modifyRecord(@RequestBody ReInspectionRequest res){
         service.modifyItpHistory(res);
@@ -63,6 +75,7 @@ public class ZhcxOutsideInspectionItpController {
      *
      * @return
      */
+    @ApiIgnore
     @PostMapping("/genLastHourInspection")
     public R genLastHourInspection(){
         reprotSameDayRealTimeInspectionStatisticsService.genStatistics();
@@ -75,6 +88,7 @@ public class ZhcxOutsideInspectionItpController {
      * @param req
      * @return
      */
+    @ApiOperation("保存报验单")
     @PostMapping("/insertInspection")
     public R insertInspection(@RequestBody OutsideInspectionInsertRequest req){
         service.insertInspection(req);
@@ -87,6 +101,7 @@ public class ZhcxOutsideInspectionItpController {
      * @param req
      * @return
      */
+    @ApiOperation("修改报验单")
     @PostMapping("/updateInspection")
     public R updateInspection(@RequestBody OutsideInspectionUpdateRequest req){
         service.updateInspection(req);
@@ -99,6 +114,7 @@ public class ZhcxOutsideInspectionItpController {
      * @param req
      * @return
      */
+    @ApiOperation("推送到报送平台")
     @PostMapping("/syncBsPlatform")
     public R syncBsPlatform(@RequestBody OutsideInspactionSyncReqquest req){
         service.sync2SubmissionPlatform(req);