Ver Fonte

feat: add api doc of tree

woooodyy há 5 anos atrás
pai
commit
a053a393b0

+ 16 - 6
web/src/main/java/seecoder/devcloud/web/controller/tree/TreeNodesController.java

@@ -1,8 +1,8 @@
 package seecoder.devcloud.web.controller.tree;
 
 
-import org.apache.ibatis.annotations.Delete;
-import org.apache.ibatis.annotations.Param;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 import seecoder.devcloud.web.po.TreeNodePO;
@@ -12,16 +12,18 @@ import seecoder.devcloud.web.vo.TreeNodeVO;
 
 import java.util.List;
 
-@RestController
-@RequestMapping("/tree")
 /**
  * @Author cyz,xzh
  * @Description 需求树相关操作
  */
+@Api("需求相关API")
+@RestController
+@RequestMapping("/tree")
 public class TreeNodesController {
     @Autowired
     private TreeNodeService treeNodeService;
     //注意 这里混用po和vo了
+    @ApiOperation("获取所有nodes")
     @GetMapping("/all")
     public List<TreeNodePO> getAllNodes(){
         return treeNodeService.getAllNodes();
@@ -32,25 +34,33 @@ public class TreeNodesController {
      * @param projectId
      * @return
      */
+    @ApiOperation("获取project_id对应的所有nodes")
     @GetMapping("/{projectId}")
     public Response listTreeNodesByProjectId(@PathVariable("projectId") int projectId){
         return treeNodeService.listTreeNodesByProjectId(projectId);
     }
 
-
+    @ApiOperation("插入节点")
     @PostMapping("/node")
     public Response insertTreeNode(TreeNodeVO treeNodeVO){
         return treeNodeService.insertTreeNode(treeNodeVO);
     }
 
+    @ApiOperation("根据nodeId删除节点")
     @DeleteMapping("/node/{nodeId}")
     public Response deleteTreeNode(@PathVariable("nodeId") int nodeId) {
         return Response.ok(treeNodeService.deleteTreeNode(nodeId));
     }
-
+    @ApiOperation("根据父节点fatherId创建一个子节点并返回")
     @PostMapping("/subNode/{fatherId}")
     public Response insertTreeNodeByFatherNode(@PathVariable("fatherId") int fatherId){
         Response res = treeNodeService.insertTreeNodeByFatherNode(fatherId);
         return res;
     }
+
+    @ApiOperation("修改节点属性")
+    @PutMapping("/node")
+    public Response updateTreeNode(@RequestBody TreeNodeVO treeNodeVO){
+        return treeNodeService.updateTreeNode(treeNodeVO);
+    }
 }

+ 2 - 0
web/src/main/java/seecoder/devcloud/web/dao/tree/TreeNodeMapper.java

@@ -77,6 +77,8 @@ public interface TreeNodeMapper {
 
     @Delete("delete from tree_nodes where id = #{nodeId}")
     int deleteTreeNode(@Param("nodeId") int nodeId);
+    @Update("update tree_nodes set ")
+    int updateTreeNodeById(@Param("nodeId") int nodeId);
 
 //    @Delete("delete from group_member where group_id = #{groupId} and user_id = #{userId}")
 //    int delete(@Param("groupId") int groupId,@Param("userId")  int userId);

+ 10 - 0
web/src/main/java/seecoder/devcloud/web/service/impl/tree/TreeNodeServiceImpl.java

@@ -4,12 +4,19 @@ package seecoder.devcloud.web.service.impl.tree;
 import org.springframework.beans.BeanUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
+import seecoder.devcloud.web.aop.TreeLogging;
+import seecoder.devcloud.web.enums.NodeStateEnum;
+import seecoder.devcloud.web.enums.NodeTypeEnum;
+import seecoder.devcloud.web.enums.OperationEnum;
 import seecoder.devcloud.web.po.TreeNodePO;
 import seecoder.devcloud.web.service.tree.TreeNodeService;
+import seecoder.devcloud.web.utils.TimeUtils;
 import seecoder.devcloud.web.vo.Response;
 import seecoder.devcloud.web.vo.TreeNodeVO;
 import seecoder.devcloud.web.dao.tree.TreeNodeMapper;
 
+import java.text.SimpleDateFormat;
+import java.util.Date;
 import java.util.List;
 
 @Service
@@ -63,6 +70,7 @@ public class TreeNodeServiceImpl implements TreeNodeService {
      * @return
      */
     @Override
+    @TreeLogging(OperationEnum.START)
     public Response insertTreeNodeByFatherNode(int fatherId) {
         TreeNodePO treeNodePO = getDefaultTreeNodePO();
         treeNodePO.setParentId(fatherId);
@@ -74,6 +82,8 @@ public class TreeNodeServiceImpl implements TreeNodeService {
         return Response.ok(treeNodePO.getId());
     }
 
+
+
     /**
      * 创建一个default的节点
      * @param

+ 2 - 0
web/src/main/java/seecoder/devcloud/web/service/tree/TreeNodeService.java

@@ -46,4 +46,6 @@ public interface TreeNodeService {
      * @return
      */
     public Response insertTreeNodeByFatherNode(int fatherId);
+
+
 }