Browse Source

接口注释添加

fangpy 1 năm trước cách đây
mục cha
commit
cce467f2ed

+ 30 - 6
business-entity/src/main/java/com/rongwei/bsentity/vo/CopyAddTemplateVo.java

@@ -2,19 +2,43 @@ package com.rongwei.bsentity.vo;
 
 import com.rongwei.bsentity.domain.ZhcxItpTemplateDo;
 import com.rongwei.bsentity.domain.ZhcxItpTemplateNodesDo;
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.*;
+
 import java.util.List;
 
-@Data
+@Setter
+@Getter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@ApiModel
 public class CopyAddTemplateVo {
 
+    /**
+     * 待复制保存的子节点id
+     */
+    @ApiModelProperty("待复制保存的子节点id")
     private String targetTmpId;
-
+    /**
+     * 引用模板ID
+     */
+    @ApiModelProperty("引用模板ID")
     private List<String> tmpIds;
-
+    /**
+     * 引用模板节点ID
+     */
+    @ApiModelProperty("引用模板节点ID")
     private List<String> tmpNodeIds;
-
+    /**
+     * 引用模板名称
+     */
+    @ApiModelProperty("引用模板名称")
     private List<String> tmpNames;
-
+    /**
+     * 目标节点对象
+     */
+    @ApiModelProperty("目标节点对象")
     private ZhcxItpTemplateDo targetTemplate;
 }

+ 22 - 4
business-entity/src/main/java/com/rongwei/bsentity/vo/CopyNodeVo.java

@@ -1,16 +1,34 @@
 package com.rongwei.bsentity.vo;
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.*;
+
 import java.util.List;
 import java.util.Map;
 
-@Data
+@Setter
+@Getter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@ApiModel
 public class CopyNodeVo {
 
+    /**
+     * 项目ID
+     */
+    @ApiModelProperty("项目ID")
     private String projectid;
-
+    /**
+     * 复制的源节点
+     */
+    @ApiModelProperty("复制的源节点")
     private String copysourceid;
-
+    /**
+     * 复制的目标节点
+     */
+    @ApiModelProperty("复制的目标节点")
     private List<Map<String,Object>> copytoid;
 
 }

+ 18 - 3
business-entity/src/main/java/com/rongwei/bsentity/vo/ZhcxItpTemplateNodeSyncProjectVo.java

@@ -1,13 +1,28 @@
 package com.rongwei.bsentity.vo;
 
-import lombok.Data;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.*;
+
 import java.util.List;
 
-@Data
+@Setter
+@Getter
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@ApiModel
 public class ZhcxItpTemplateNodeSyncProjectVo {
 
+    /**
+     * 当前报验点ID
+     */
+    @ApiModelProperty("当前报验点ID")
     private String nodeid;
-
+    /**
+     * 待同步的项目ID
+     */
+    @ApiModelProperty("待同步的项目ID")
     private List<String> projectids;
 
 }

+ 18 - 0
business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxItpProjectNodesController.java

@@ -7,6 +7,9 @@ import com.rongwei.bsentity.vo.CopyNodeVo;
 import com.rongwei.rwcommon.base.R;
 import com.rongwei.rwcommoncomponent.excel.vo.FormData;
 import com.rongwei.rwcommonentity.commonservers.domain.SysFileItemDo;
+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;
@@ -32,18 +35,33 @@ public class ZhcxItpProjectNodesController {
     @Autowired
     private ZhcxItpProjectNodesService zhcxItpProjectNodesService;
 
+    @ApiOperation("项目引用ITP模板节点")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "projectId",required = true, value = "项目ID", dataType = "string"),
+            @ApiImplicitParam(name = "itpTemplateId",required = true, value = "待引用的模板ID", dataType = "string"),
+            @ApiImplicitParam(name = "projectDeviceNumberIds", value = "项目机号ID", dataType = "string"),
+            @ApiImplicitParam(name = "projectDeviceNumberNames", value = "项目机号名称", dataType = "string")
+    })
     @PostMapping("/projectNodeQuote")
     public R projectNodeQuote(@RequestBody Map<String,Object> map){
         zhcxItpProjectNodesService.projectNodeQuote(map);
         return R.ok();
     }
 
+    @ApiOperation("项目引用项目ITP节点")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "projectId",required = true, value = "项目ID", dataType = "string"),
+            @ApiImplicitParam(name = "refProjectId",required = true, value = "待引用的项目ID", dataType = "string"),
+            @ApiImplicitParam(name = "projectDeviceNumberIds", value = "项目机号ID", dataType = "string"),
+            @ApiImplicitParam(name = "projectDeviceNumberNames", value = "项目机号名称", dataType = "string")
+    })
     @PostMapping("/projectRefProject")
     public R projectRefProject(@RequestBody Map<String,Object> map){
         zhcxItpProjectNodesService.projectRefProject(map);
         return R.ok();
     }
 
+    @ApiOperation("复制项目节点")
     @PostMapping("/copyProjectNode")
     public R copyProjectNode(@RequestBody CopyNodeVo copyNodeVo){
         List<Map<String, Object>> maps = zhcxItpProjectNodesService.copyProjectNode(copyNodeVo);

+ 5 - 1
business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxItpTemplateController.java

@@ -6,6 +6,7 @@ import com.rongwei.bscommon.sys.service.ZhcxItpTemplateService;
 import com.rongwei.bsentity.vo.CopyAddTemplateVo;
 import com.rongwei.bsentity.vo.ZhcxItpTemplateNodeSyncProjectVo;
 import com.rongwei.rwcommon.base.R;
+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;
@@ -32,12 +33,14 @@ public class ZhcxItpTemplateController {
     @Autowired
     private ZhcxItpTemplateNodesService zhcxItpTemplateNodesService;
 
+    @ApiOperation("复制新增的引用所有子节点")
     @PostMapping("/copyAddTemplateNodes")
     public R copyAddTemplateNodes(@RequestBody CopyAddTemplateVo copyAddTemplate){
         zhcxItpTemplateService.copyAddTemplateNodes(copyAddTemplate);
         return R.ok();
     }
 
+    @ApiOperation("更换层级引用复制节点并保存层级引用、并返回数据")
     @PostMapping("/copyNodesSave")
     public R copyNodesSave(@RequestBody CopyAddTemplateVo copyAddTemplate){
         List<Map<String, Object>> maps = zhcxItpTemplateService.copyNodesSave(copyAddTemplate);
@@ -45,10 +48,11 @@ public class ZhcxItpTemplateController {
     }
 
     /**
-     * ITP模板新增报验点同步到项目中
+     * 新增的ITP模板节点同步到指定项目
      * @param zhcxItpTemplateNodeSyncProjectVo
      * @return
      */
+    @ApiOperation("新增的ITP模板节点同步到指定项目")
     @PostMapping("/itpTemplateAddNodeSyncProjects")
     public R itpTemplateAddNodeSyncProjects(@RequestBody ZhcxItpTemplateNodeSyncProjectVo zhcxItpTemplateNodeSyncProjectVo){
         zhcxItpTemplateNodesService.itpTemplateAddNodeSyncProjects(zhcxItpTemplateNodeSyncProjectVo);

+ 2 - 0
business-server/src/main/java/com/rongwei/bsserver/controller/ZhcxItpTemplateNodesController.java

@@ -4,6 +4,7 @@ package com.rongwei.bsserver.controller;
 import com.rongwei.bscommon.sys.service.ZhcxItpTemplateNodesService;
 import com.rongwei.bsentity.vo.CopyNodeVo;
 import com.rongwei.rwcommon.base.R;
+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;
@@ -28,6 +29,7 @@ public class ZhcxItpTemplateNodesController {
     @Autowired
     private ZhcxItpTemplateNodesService zhcxItpTemplateNodesService;
 
+    @ApiOperation("复制ITP地图模板节点")
     @PostMapping("/copyItpTemplateNode")
     public R copyItpTemplateNode(@RequestBody CopyNodeVo copyNodeVo){
         List<Map<String, Object>> maps = zhcxItpTemplateNodesService.copyItpTemplateNode(copyNodeVo);