doc: tree swagger注释补完

web/src/main/java/seecoder/devcloud/web/controller/pipeline/DeploymentController.java

@@ -30,7 +30,7 @@ public class DeploymentController {
     }
 
     @ApiOperation(value = "获取项目所有部署的实例信息", httpMethod = "GET")
-    @ApiImplicitParam(name = "projectId", dataType = "int")
+    @ApiImplicitParam(name = "projectId", dataType = "int", paramType = "query")
     @GetMapping("/list")
     public Response<List<DeploymentInfoVO>> retrieveDeploymentInfos(@RequestParam("projectId")Integer projectId){
         return Response.buildSuccess(deploymentService.retrieveDeploymentInfos(projectId));
@@ -39,8 +39,8 @@ public class DeploymentController {
 
     @ApiOperation(value = "执行流水线构建实例", httpMethod = "POST")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int")
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query")
     })
     @PostMapping
     public Response deploy(@RequestParam("projectId")Integer projectId,
@@ -55,8 +55,8 @@ public class DeploymentController {
      */
     @ApiOperation(value = "删除一个部署的实例", httpMethod = "DELETE")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int")
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query")
     })
     @DeleteMapping
     public Response delete(@RequestParam("projectId")Integer projectId,

web/src/main/java/seecoder/devcloud/web/controller/pipeline/PipelineController.java

@@ -37,7 +37,7 @@ public class PipelineController {
 
     @GetMapping("/list")
     @ApiOperation(value = "获取指定项目的所有流水线基本信息", httpMethod = "GET")
-    @ApiImplicitParam(name = "projectId", dataType = "int")
+    @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query")
     public Response<List<PipelineInfoVO>> retrievePipelineInfos(@RequestParam("projectId") Integer projectId){
         return Response.buildSuccess(pipelineService.retrievePipelineInfos(projectId));
     }
@@ -45,8 +45,8 @@ public class PipelineController {
     @GetMapping
     @ApiOperation(value = "获取指定一条流水线的配置json信息", httpMethod = "GET")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int")
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query")
     })
     public Response<PipelineConfigVO> retrievePipelineConfig(@RequestParam("projectId")Integer projectId,
                                                              @RequestParam("pipelineId")Integer pipelineId){
@@ -57,8 +57,8 @@ public class PipelineController {
     @GetMapping("/history/list")
     @ApiOperation(value = "获取指定一条流水线的历史构建信息列表", httpMethod = "GET")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int")
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query")
     })
     public Response<List<PipelineHistoryVO>> retrievePipelineHistory(@RequestParam("projectId")Integer projectId,
                                                                      @RequestParam("pipelineId")Integer pipelineId){
@@ -67,7 +67,7 @@ public class PipelineController {
 
 
     @ApiOperation(value = "依据模板创建一个流水线配置", httpMethod = "POST")
-    @ApiImplicitParam(name = "pipelineCreateVO", value = "流水线创建配置信息",dataType = "PipelineCreateVO")
+    @ApiImplicitParam(name = "pipelineCreateVO", value = "流水线创建配置信息",dataType = "PipelineCreateVO",paramType = "body")
     @PostMapping
     public Response createPipelineConfig(@RequestBody PipelineCreateVO pipelineCreateVO){
         pipelineService.createPipelineConfig(pipelineCreateVO);
@@ -77,9 +77,9 @@ public class PipelineController {
     @PutMapping("/config")
     @ApiOperation(value = "保存修改一条流水线的json配置信息", httpMethod = "PUT")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int"),
-            @ApiImplicitParam(name = "configJson", dataType = "String")
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "configJson", dataType = "String",paramType = "query")
     })
     public Response savePipelineConfig(@RequestParam("projectId")Integer projectId,
                                        @RequestParam("pipelineId")Integer pipelineId,
@@ -91,8 +91,8 @@ public class PipelineController {
 
     @ApiOperation(value = "删除一条流水线", httpMethod = "DELETE")
     @ApiImplicitParams({
-            @ApiImplicitParam(name = "projectId", dataType = "int"),
-            @ApiImplicitParam(name = "pipelineId", dataType = "int"),
+            @ApiImplicitParam(name = "projectId", dataType = "int",paramType = "query"),
+            @ApiImplicitParam(name = "pipelineId", dataType = "int",paramType = "query"),
     })
     @DeleteMapping
     public Response deletePipelineInfo(Integer projectId,Integer pipelineId){

web/src/main/java/seecoder/devcloud/web/controller/tree/TreeNodesController.java

@@ -2,10 +2,11 @@ package seecoder.devcloud.web.controller.tree;
 
 
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 import seecoder.devcloud.web.model.vo.Response;
 import seecoder.devcloud.web.model.vo.TreeNodeVO;
 import seecoder.devcloud.web.service.tree.TreeNodeService;
@@ -36,8 +37,9 @@ public class TreeNodesController {
      * @param projectId
      * @return
      */
-    @ApiOperation("获取project_id对应的所有nodes")
+    @ApiOperation(value = "获取project_id对应的所有nodes",httpMethod = "GET")
     @GetMapping("/{projectId}")
+    @ApiImplicitParam(value = "projectId",dataType = "int", paramType = "path")
     public Response listTreeNodesByProjectId(@PathVariable("projectId") int projectId){
         return treeNodeService.listTreeNodesByProjectId(projectId);
     }
@@ -50,11 +52,13 @@ public class TreeNodesController {
 
     @ApiOperation("根据nodeId删除节点")
     @DeleteMapping("/node/{nodeId}")
+    @ApiImplicitParam(value = "nodeId",dataType = "int", paramType = "path")
     public Response deleteTreeNode(@PathVariable("nodeId") int nodeId) {
         return Response.buildSuccess(treeNodeService.deleteTreeNode(nodeId));
     }
     @ApiOperation("根据父节点fatherId创建一个子节点并返回")
     @PostMapping("/subNode/{fatherId}")
+    @ApiImplicitParam(value = "fatherId",dataType = "int", paramType = "path")
     public Response insertTreeNodeByFatherNode(@PathVariable("fatherId") int fatherId){
         Response res = treeNodeService.insertTreeNodeByFatherNode(fatherId);
         return res;
@@ -62,6 +66,7 @@ public class TreeNodesController {
 
     @ApiOperation("修改节点属性")
     @PutMapping("/node")
+    @ApiImplicitParam(value = "treeNodeVO",dataType = "TreeNodeVO", paramType = "body")
     public Response updateTreeNode(@RequestBody TreeNodeVO treeNodeVO){
         return treeNodeService.updateTreeNode(treeNodeVO);
     }

web/src/main/java/seecoder/devcloud/web/dao/provider/TreeNodeProvider.java

@@ -1,7 +1,7 @@
 package seecoder.devcloud.web.dao.provider;
 
 import org.apache.ibatis.jdbc.SQL;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 
 public class TreeNodeProvider {
     public String updateTreeNode(TreeNodePO TreeNodePO){

web/src/main/java/seecoder/devcloud/web/dao/tree/TreeNodeMapper.java

@@ -3,7 +3,7 @@ package seecoder.devcloud.web.dao.tree;
 
 import org.apache.ibatis.annotations.*;
 import org.springframework.stereotype.Repository;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 import seecoder.devcloud.web.dao.provider.TreeNodeProvider;
 
 import java.util.List;

web/src/main/java/seecoder/devcloud/web/model/po/TreeNodePO.java → web/src/main/java/seecoder/devcloud/web/model/po/tree/TreeNodePO.java

@@ -1,4 +1,4 @@
-package seecoder.devcloud.web.model.po;
+package seecoder.devcloud.web.model.po.tree;
 
 
 

web/src/main/java/seecoder/devcloud/web/model/vo/TreeNodeVO.java

@@ -1,5 +1,7 @@
 package seecoder.devcloud.web.model.vo;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -10,20 +12,40 @@ import seecoder.devcloud.web.model.enums.NodeTypeEnum;
 @NoArgsConstructor
 @Data
 @AllArgsConstructor
+@ApiModel("树节点")
 public class TreeNodeVO {
+
+    @ApiModelProperty("树节点id")
     private int id;
+
+    @ApiModelProperty("用户id")
     private int userId; /*操作用户的ID*/
+
+    @ApiModelProperty("节点名称")
     private String title;
+    @ApiModelProperty("节点描述")
     private String description;
+
+    @ApiModelProperty("节点类型，有效值为 “0:需求”, “1:任务”")
     private NodeTypeEnum type;
+    @ApiModelProperty("节点优先级")
     private int priority;
+    @ApiModelProperty("节点状态类型，有效值为 “0:已创建”, “1:进行中”, “2:已结束”")
     private NodeStateEnum state;
+    @ApiModelProperty("预计完成时间")
     private int timeToTake;
+    @ApiModelProperty("起始时间")
     private String startTime;
+    @ApiModelProperty("结束时间")
     private String endTime;
+    @ApiModelProperty("是否为叶节点")
     private boolean leaf;
+    @ApiModelProperty("所属组id")
     private int groupId;
+    @ApiModelProperty("所属项目id")
     private int projectId;
+    @ApiModelProperty("父节点id")
     private int parentId;
+    @ApiModelProperty("节点深度")
     private int deep;
 }

web/src/main/java/seecoder/devcloud/web/service/impl/tree/TreeNodeServiceImpl.java

@@ -9,7 +9,7 @@ import seecoder.devcloud.web.aop.TreeLogging;
 import seecoder.devcloud.web.model.enums.NodeStateEnum;
 import seecoder.devcloud.web.model.enums.NodeTypeEnum;
 import seecoder.devcloud.web.model.enums.OperationEnum;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 import seecoder.devcloud.web.service.tree.TreeNodeService;
 import seecoder.devcloud.web.model.vo.Response;
 import seecoder.devcloud.web.model.vo.TreeNodeVO;

web/src/main/java/seecoder/devcloud/web/service/tree/TreeNodeService.java

@@ -3,7 +3,7 @@ package seecoder.devcloud.web.service.tree;
 
 
 
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 import seecoder.devcloud.web.model.vo.Response;
 import seecoder.devcloud.web.model.vo.TreeNodeVO;
 

web/src/main/resources/application-xzh.yml

@@ -52,4 +52,7 @@ seecoder:
     password: admin123
     nexus-server: 192.168.68.79:18081
     repo-name: sec-repo
-    clean-up-task: 83bb8249-71e8-4367-83b3-50c6f7518860
+    clean-up-task: 83bb8249-71e8-4367-83b3-50c6f7518860
+  git:
+    password: mock
+    username: mock

web/src/test/java/seecoder/devcloud/web/dao/tree/TreeNodeMapperTest.java

@@ -6,10 +6,9 @@ import org.mybatis.spring.boot.test.autoconfigure.MybatisTest;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
 import org.springframework.test.context.junit4.SpringRunner;
-import seecoder.devcloud.web.dao.tree.TreeNodeMapper;
 import seecoder.devcloud.web.model.enums.NodeStateEnum;
 import seecoder.devcloud.web.model.enums.NodeTypeEnum;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 
 
 import java.util.List;

web/src/test/java/seecoder/devcloud/web/service/TreeNodeServiceTest.java

@@ -10,7 +10,7 @@ import org.springframework.transaction.annotation.Transactional;
 import seecoder.devcloud.web.DevcloudWebApplication;
 import seecoder.devcloud.web.model.enums.NodeStateEnum;
 import seecoder.devcloud.web.model.enums.NodeTypeEnum;
-import seecoder.devcloud.web.model.po.TreeNodePO;
+import seecoder.devcloud.web.model.po.tree.TreeNodePO;
 import seecoder.devcloud.web.service.tree.TreeNodeService;
 import seecoder.devcloud.web.model.vo.TreeNodeVO;