Browse Source

增加注释

shiyue 1 năm trước cách đây
mục cha
commit
30ecf1d759

+ 11 - 0
energy-manage-common/src/main/java/com/energy/manage/common/po/system/SysPermissionPO.java

@@ -1,6 +1,7 @@
 package com.energy.manage.common.po.system;
 
 import com.energy.manage.common.base.NewBaseDomain;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
@@ -23,50 +24,60 @@ public class SysPermissionPO {
     /**
      * 资源表主键id
      */
+    @ApiModelProperty("资源表主键id")
     private Integer permissionId;
 
     /**
      * 资源名称
      */
+    @ApiModelProperty("资源名称")
     private String permissionName;
 
     /**
      * 资源父id
      */
+    @ApiModelProperty("资源父id")
     private Integer parentId;
 
     /**
      * 资源code
      */
+    @ApiModelProperty("资源code")
     private String permissionCode;
 
     /**
      * 资源类型(1 位菜单 2 为功能)
      */
+    @ApiModelProperty("资源类型(1 位菜单 2 为功能)")
     private Integer permissionType;
 
     /**
      * 资源url
      */
+    @ApiModelProperty("资源url")
     private String permissionUrl;
 
     /**
      * 资源状态 0 不可用 1是正常
      */
+    @ApiModelProperty("源状态 0 不可用 1是正常")
     private Integer permissionState;
 
     /**
      * 顺序
      */
+    @ApiModelProperty("顺序")
     private Integer permissionSort;
 
     /**
      * 图标icon Url
      */
+    @ApiModelProperty("图标icon Url")
     private String permissionIconUrl;
 
     /**
      * 所有父id集合
      */
+    @ApiModelProperty("所有父id集合")
     private Integer permissionDepth;
 }

+ 16 - 16
energy-manage-service/src/main/java/com/energy/manage/service/controller/system/SysPermissionController.java

@@ -41,18 +41,18 @@ public class SysPermissionController {
     @ApiOperation(value = "增加权限")
     @PostMapping(value = "add")
     public ResultResp addPermission(@RequestBody PermissionDto permissionDto) {
-        if (StringUtils.isEmpty(permissionDto.getPName()) || StringUtils.isEmpty(permissionDto.getPCode())) {
+        if (StringUtils.isEmpty(permissionDto.getPname()) || StringUtils.isEmpty(permissionDto.getPcode())) {
             return ResultResp.NOTNULLPARAM();
         }
         SysPermissionPO po = new SysPermissionPO();
         po.setParentId(permissionDto.getParentId());
-        po.setPermissionName(permissionDto.getPName());
-        po.setPermissionUrl(permissionDto.getPUrl());
-        po.setPermissionCode(permissionDto.getPCode());
-        po.setPermissionIconUrl(permissionDto.getPIconUrl());
-        po.setPermissionState(permissionDto.getPStat());
-        po.setPermissionType(permissionDto.getPType());
-        po.setPermissionSort(permissionDto.getPSort());
+        po.setPermissionName(permissionDto.getPname());
+        po.setPermissionUrl(permissionDto.getPurl());
+        po.setPermissionCode(permissionDto.getPcode());
+        po.setPermissionIconUrl(permissionDto.getPiconUrl());
+        po.setPermissionState(permissionDto.getPstat());
+        po.setPermissionType(permissionDto.getPtype());
+        po.setPermissionSort(permissionDto.getPsort());
         boolean flg = sysPermissionService.addPermission(po);
         if (flg) {
             return ResultResp.SUCCESS();
@@ -90,18 +90,18 @@ public class SysPermissionController {
     @PostMapping(value = "update")
     public ResultResp updatePermission(@RequestBody PermissionUpdateDto permissionUpdateDto) {
 
-        if (!Optional.ofNullable(permissionUpdateDto.getPermissionId()).isPresent() || StringUtils.isEmpty(permissionUpdateDto.getPName()) || StringUtils.isEmpty(permissionUpdateDto.getPCode())) {
+        if (!Optional.ofNullable(permissionUpdateDto.getPermissionId()).isPresent() || StringUtils.isEmpty(permissionUpdateDto.getPname()) || StringUtils.isEmpty(permissionUpdateDto.getPcode())) {
             return ResultResp.NOTNULLPARAM();
         }
         SysPermissionPO po = new SysPermissionPO();
         po.setPermissionId(permissionUpdateDto.getPermissionId());
-        po.setPermissionName(permissionUpdateDto.getPName());
-        po.setPermissionUrl(permissionUpdateDto.getPUrl());
-        po.setPermissionCode(permissionUpdateDto.getPCode());
-        po.setPermissionIconUrl(permissionUpdateDto.getPIconUrl());
-        po.setPermissionState(permissionUpdateDto.getPStat());
-        po.setPermissionType(permissionUpdateDto.getPType());
-        po.setPermissionSort(permissionUpdateDto.getPSort());
+        po.setPermissionName(permissionUpdateDto.getPname());
+        po.setPermissionUrl(permissionUpdateDto.getPurl());
+        po.setPermissionCode(permissionUpdateDto.getPcode());
+        po.setPermissionIconUrl(permissionUpdateDto.getPiconUrl());
+        po.setPermissionState(permissionUpdateDto.getPstat());
+        po.setPermissionType(permissionUpdateDto.getPtype());
+        po.setPermissionSort(permissionUpdateDto.getPsort());
         boolean flag = sysPermissionService.updatePermission(po);
         if (flag) {
             return ResultResp.SUCCESS();

+ 2 - 0
energy-manage-service/src/main/java/com/energy/manage/service/domain/dto/system/LoginDto.java

@@ -1,11 +1,13 @@
 package com.energy.manage.service.domain.dto.system;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Getter;
 import lombok.Setter;
 
 @Getter
 @Setter
+@ApiModel("用户登录参数")
 public class LoginDto {
 
     @ApiModelProperty(value = "用户名字")

+ 2 - 0
energy-manage-service/src/main/java/com/energy/manage/service/domain/dto/system/PermissionDelDto.java

@@ -1,5 +1,6 @@
 package com.energy.manage.service.domain.dto.system;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Getter;
 import lombok.Setter;
@@ -9,6 +10,7 @@ import lombok.Setter;
  */
 @Getter
 @Setter
+@ApiModel("删除菜单参数")
 public class PermissionDelDto {
 
     @ApiModelProperty(value = "权限id")

+ 9 - 7
energy-manage-service/src/main/java/com/energy/manage/service/domain/dto/system/PermissionDto.java

@@ -1,5 +1,6 @@
 package com.energy.manage.service.domain.dto.system;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Getter;
 import lombok.Setter;
@@ -9,24 +10,25 @@ import lombok.Setter;
  */
 @Getter
 @Setter
+@ApiModel
 public class PermissionDto {
 
     @ApiModelProperty(value = "父id")
     private Integer parentId = 0;
     @ApiModelProperty(value = "名称")
-    private String pName;
+    private String pname;
     @ApiModelProperty(value = "code")
-    private String pCode;
+    private String pcode;
     @ApiModelProperty(value = "链接")
-    private String pUrl;
+    private String purl;
     @ApiModelProperty(value = "图标地址")
-    private String pIconUrl;
+    private String piconUrl;
     @ApiModelProperty(value = "状态 资源状态 0 不可用 1是正常")
-    private Integer pStat = 1;
+    private Integer pstat = 1;
     @ApiModelProperty(value = "类型 资源类型(1 位菜单 2 为功能)")
-    private Integer pType = 1;
+    private Integer ptype = 1;
     @ApiModelProperty(value = "权限id")
-    private Integer pSort = 100000;
+    private Integer psort = 100000;
 
 
 }

+ 9 - 7
energy-manage-service/src/main/java/com/energy/manage/service/domain/dto/system/PermissionUpdateDto.java

@@ -1,5 +1,6 @@
 package com.energy.manage.service.domain.dto.system;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Getter;
 import lombok.Setter;
@@ -9,24 +10,25 @@ import lombok.Setter;
  */
 @Getter
 @Setter
+@ApiModel("更新菜单参数")
 public class PermissionUpdateDto {
 
     @ApiModelProperty(value = "权限id")
     private Integer permissionId;
     @ApiModelProperty(value = "名字")
-    private String pName;
+    private String pname;
     @ApiModelProperty(value = "code")
-    private String pCode;
+    private String pcode;
     @ApiModelProperty(value = "链接")
-    private String pUrl;
+    private String purl;
     @ApiModelProperty(value = "图标地址")
-    private String pIconUrl;
+    private String piconUrl;
     @ApiModelProperty(value = "状态 资源状态 0 不可用 1是正常")
-    private Integer pStat = 1;
+    private Integer pstat = 1;
     @ApiModelProperty(value = "类型 资源类型(1 位菜单 2 为功能)")
-    private Integer pType = 1;
+    private Integer ptype = 1;
     @ApiModelProperty(value = "")
-    private Integer pSort = 100000;
+    private Integer psort = 100000;
 
 
 }