Kaynağa Gözat

对enum增加swagger注释

lixing 4 yıl önce
ebeveyn
işleme
3a6133bf4d
24 değiştirilmiş dosya ile 50 ekleme ve 27 silme
  1. 0 5
      fm-person/src/main/java/com/persagy/fm/department/constant/enums/DepTypeEnum.java
  2. 3 0
      fm-person/src/main/java/com/persagy/fm/department/constant/enums/ResourceFromEnum.java
  3. 2 0
      fm-person/src/main/java/com/persagy/fm/department/jms/handler/GroupMsgHandler.java
  4. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/Department.java
  5. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/dto/AddDepartmentDTO.java
  6. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/dto/PageQueryDepartmentDTO.java
  7. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/dto/QueryDepartmentDTO.java
  8. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/dto/UpdateDepartmentDTO.java
  9. 3 2
      fm-person/src/main/java/com/persagy/fm/department/model/vo/ResponseDepartmentItemVO.java
  10. 2 2
      fm-person/src/main/java/com/persagy/fm/department/model/vo/ResponseDepartmentListItemVO.java
  11. 2 0
      fm-person/src/main/java/com/persagy/fm/person/constant/enums/CertificateTypeEnum.java
  12. 2 0
      fm-person/src/main/java/com/persagy/fm/person/constant/enums/PersonTypeEnum.java
  13. 2 2
      fm-person/src/main/java/com/persagy/fm/person/model/Person.java
  14. 1 1
      fm-person/src/main/java/com/persagy/fm/person/model/dto/BatchUpdatePersonDTO.java
  15. 2 2
      fm-person/src/main/java/com/persagy/fm/person/model/dto/UpsertPersonDTO.java
  16. 2 2
      fm-person/src/main/java/com/persagy/fm/person/model/vo/ResponsePersonItemVO.java
  17. 1 1
      fm-person/src/main/java/com/persagy/fm/person/model/vo/ResponsePersonListItemVO.java
  18. 2 0
      fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/AccountBelongEnum.java
  19. 3 0
      fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/AccountTypeEnum.java
  20. 5 0
      fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/ExpireTypeEnum.java
  21. 2 0
      fm-person/src/main/java/com/persagy/fm/saas/accountrole/constant/enums/AccountRoleTypeEnum.java
  22. 2 0
      fm-person/src/main/java/com/persagy/fm/saas/role/constant/enums/RoleTypeEnum.java
  23. 2 0
      fm-person/src/main/java/com/persagy/fm/workresume/constant/enums/WorkResumeEnableStateEnum.java
  24. 2 0
      fm-person/src/main/java/com/persagy/fm/workresume/constant/enums/WorkResumeHiredStateEnum.java

+ 0 - 5
fm-person/src/main/java/com/persagy/fm/department/constant/enums/DepTypeEnum.java

@@ -40,9 +40,4 @@ public enum DepTypeEnum {
     public void setDesc(String desc) {
         this.desc = desc;
     }
-
-    @Override
-    public String toString() {
-        return type + ":" + desc;
-    }
 }

+ 3 - 0
fm-person/src/main/java/com/persagy/fm/department/constant/enums/ResourceFromEnum.java

@@ -1,11 +1,14 @@
 package com.persagy.fm.department.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
+
 /**
  * 数据来源
  *
  * @author lixing
  * @version V1.0 2021/3/12 3:03 下午
  */
+@SwaggerDisplayEnum
 public enum ResourceFromEnum {
     /**
      * 数据来源

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/department/jms/handler/GroupMsgHandler.java

@@ -134,6 +134,8 @@ public class GroupMsgHandler{
             } else {
                 log.error("集团下已包含类型为集团的部门,拒绝重复创建");
             }
+
+
         }
     }
 }

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/Department.java

@@ -24,13 +24,13 @@ public class Department extends AuditableEntity<Department> implements Serializa
     @ApiModelProperty("部门名称")
     private String name;
 
-    @ApiModelProperty("部门类型")
+    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty("上级部门id")
     private String parentId;
 
-    @ApiModelProperty("数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty("负责人")

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/dto/AddDepartmentDTO.java

@@ -26,7 +26,7 @@ public class AddDepartmentDTO {
             message = "部门名称" + RegexConstants.NAME_REGEX_WARNING)
     private String name;
 
-    @ApiModelProperty(value = "部门类型", required = true)
+    @ApiModelProperty(value = "部门类型", required = true, notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     @NotNull(message = "部门类型不能为空")
     private String type;
 
@@ -34,7 +34,7 @@ public class AddDepartmentDTO {
     @NotNull(message = "上级部门id不能为空")
     private String parentId;
 
-    @ApiModelProperty(value = "数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty(value = "负责人")

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/dto/PageQueryDepartmentDTO.java

@@ -19,13 +19,13 @@ public class PageQueryDepartmentDTO extends PageDTO {
     @ApiModelProperty(value = "部门名称", required = true)
     private String name;
 
-    @ApiModelProperty(value = "部门类型", required = true)
+    @ApiModelProperty(value = "部门类型", required = true, notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty(value = "上级部门id", required = true)
     private String parentId;
 
-    @ApiModelProperty(value = "数据来源", required = true)
+    @ApiModelProperty(value = "数据来源", required = true, notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
 //    @ApiModelProperty(value = "负责人", required = true)

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/dto/QueryDepartmentDTO.java

@@ -14,13 +14,13 @@ public class QueryDepartmentDTO {
     @ApiModelProperty(value = "部门名称")
     private String name;
 
-    @ApiModelProperty(value = "部门类型")
+    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty(value = "上级部门id")
     private String parentId;
 
-    @ApiModelProperty(value = "数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty(value = "部门全路径, 模糊查询")

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/dto/UpdateDepartmentDTO.java

@@ -29,13 +29,13 @@ public class UpdateDepartmentDTO {
             message = "部门名称" + RegexConstants.NAME_REGEX_WARNING)
     private String name;
 
-    @ApiModelProperty(value = "部门类型")
+    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty(value = "上级部门id")
     private String parentId;
 
-    @ApiModelProperty(value = "数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty(value = "负责人")

+ 3 - 2
fm-person/src/main/java/com/persagy/fm/department/model/vo/ResponseDepartmentItemVO.java

@@ -27,7 +27,7 @@ public class ResponseDepartmentItemVO {
     @ApiModelProperty("部门名称")
     private String name;
 
-    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DeptTypeEnum")
+    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty("上级部门id")
@@ -36,7 +36,7 @@ public class ResponseDepartmentItemVO {
     @ApiModelProperty("上级部门名称")
     private String parentShowName;
 
-    @ApiModelProperty("数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty("负责人列表")
@@ -65,4 +65,5 @@ public class ResponseDepartmentItemVO {
 
     @ApiModelProperty(value="关联的项目")
     private List<ProjectSimpleObjVO> projects;
+
 }

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/department/model/vo/ResponseDepartmentListItemVO.java

@@ -25,13 +25,13 @@ public class ResponseDepartmentListItemVO {
     @ApiModelProperty("部门名称")
     private String name;
 
-    @ApiModelProperty("部门类型")
+    @ApiModelProperty(value = "部门类型", notes = "com.persagy.fm.department.constant.enums.DepTypeEnum")
     private String type;
 
     @ApiModelProperty("上级部门id")
     private String parentId;
 
-    @ApiModelProperty("数据来源")
+    @ApiModelProperty(value = "数据来源", notes = "com.persagy.fm.department.constant.enums.ResourceFromEnum")
     private String resourceFrom;
 
     @ApiModelProperty("负责人")

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/person/constant/enums/CertificateTypeEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.person.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/19 6:14 下午
  **/
+@SwaggerDisplayEnum
 public enum CertificateTypeEnum {
     /**
      * 证件类型

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/person/constant/enums/PersonTypeEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.person.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/12 3:00 下午
  */
+@SwaggerDisplayEnum
 public enum PersonTypeEnum {
     /**
      * 员工类型

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/person/model/Person.java

@@ -36,7 +36,7 @@ public class Person extends AuditableEntity<Person> implements Serializable {
     @ApiModelProperty("证件号码")
     private String idNumber;
 
-    @ApiModelProperty("证件类型")
+    @ApiModelProperty(value = "证件类型", notes = "com.persagy.fm.person.constant.enums.CertificateTypeEnum")
     private String certificateType;
 
     @ApiModelProperty("性别")
@@ -51,7 +51,7 @@ public class Person extends AuditableEntity<Person> implements Serializable {
     @ApiModelProperty("账号来源")
     private String userFrom;
 
-    @ApiModelProperty("员工类型")
+    @ApiModelProperty(value = "员工类型", notes = "com.persagy.fm.person.constant.enums.PersonTypeEnum")
     private String personType;
 
     @ApiModelProperty("备注")

+ 1 - 1
fm-person/src/main/java/com/persagy/fm/person/model/dto/BatchUpdatePersonDTO.java

@@ -20,7 +20,7 @@ public class BatchUpdatePersonDTO {
     @NotNull(message = "人员主键不能为空")
     private List<String> ids;
 
-    @ApiModelProperty(value = "员工类型")
+    @ApiModelProperty(value = "员工类型", notes = "com.persagy.fm.person.constant.enums.PersonTypeEnum")
     private String personType;
 
     @ApiModelProperty(value = "主岗")

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/person/model/dto/UpsertPersonDTO.java

@@ -38,7 +38,7 @@ public class UpsertPersonDTO {
     @ApiModelProperty(value = "性别")
     private Integer gender;
 
-    @ApiModelProperty(value = "员工类型")
+    @ApiModelProperty(value = "员工类型", notes = "com.persagy.fm.person.constant.enums.PersonTypeEnum")
     private String personType;
 
     @Pattern(regexp = RegexConstants.PHONE_OR_BLANK_REGEX, message = RegexConstants.PHONE_REGEX_WARNING)
@@ -46,7 +46,7 @@ public class UpsertPersonDTO {
     @ApiModelProperty(value = "手机号码")
     private String phoneNum;
 
-    @ApiModelProperty(value = "证件类型")
+    @ApiModelProperty(value = "证件类型", notes = "com.persagy.fm.person.constant.enums.CertificateTypeEnum")
     private String certificateType;
 
     @Pattern(regexp = RegexConstants.ID_CARD_OR_BLANK_REGEX, message = RegexConstants.ID_CARD_REGEX_WARNING)

+ 2 - 2
fm-person/src/main/java/com/persagy/fm/person/model/vo/ResponsePersonItemVO.java

@@ -43,7 +43,7 @@ public class ResponsePersonItemVO {
     @JsonIgnore
     private String personType;
 
-    @ApiModelProperty("员工类型")
+    @ApiModelProperty(value = "员工类型", notes = "com.persagy.fm.person.constant.enums.PersonTypeEnum")
     private SimpleObjVO personTypeVO;
 
     @ApiModelProperty(value = "手机号码")
@@ -53,7 +53,7 @@ public class ResponsePersonItemVO {
     @JsonIgnore
     private String certificateType;
 
-    @ApiModelProperty(value = "证件类型")
+    @ApiModelProperty(value = "证件类型", notes = "com.persagy.fm.person.constant.enums.CertificateTypeEnum")
     private SimpleObjVO certificateTypeVO;
 
     @ApiModelProperty("证件号码")

+ 1 - 1
fm-person/src/main/java/com/persagy/fm/person/model/vo/ResponsePersonListItemVO.java

@@ -32,7 +32,7 @@ public class ResponsePersonListItemVO {
     @JsonIgnore
     private String personType;
 
-    @ApiModelProperty("员工类型")
+    @ApiModelProperty(value = "员工类型", notes = "com.persagy.fm.person.constant.enums.PersonTypeEnum")
     private SimpleObjVO personTypeVO;
 
     @ApiModelProperty("账号id")

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/AccountBelongEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.saas.account.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/23 3:17 下午
  **/
+@SwaggerDisplayEnum
 public enum AccountBelongEnum {
     /**
      * 账号所属

+ 3 - 0
fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/AccountTypeEnum.java

@@ -1,11 +1,14 @@
 package com.persagy.fm.saas.account.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
+
 /**
  * 账号所属枚举类
  *
  * @author lixing
  * @version V1.0 2021/3/23 3:17 下午
  **/
+@SwaggerDisplayEnum
 public enum AccountTypeEnum {
     /**
      * 账号所属

+ 5 - 0
fm-person/src/main/java/com/persagy/fm/saas/account/constant/enums/ExpireTypeEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.saas.account.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,7 +10,11 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/4/8 8:43 下午
  **/
+@SwaggerDisplayEnum
 public enum ExpireTypeEnum {
+    /**
+     * 过期类型枚举类
+     */
     EXPIRY_DATE("0", "期内有效"),
     FOREVER("1", "永久有效");
 

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/saas/accountrole/constant/enums/AccountRoleTypeEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.saas.accountrole.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/25 10:16 上午
  **/
+@SwaggerDisplayEnum
 public enum AccountRoleTypeEnum {
     /**
      * 账号角色关联类型

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/saas/role/constant/enums/RoleTypeEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.saas.role.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/25 10:16 上午
  **/
+@SwaggerDisplayEnum
 public enum RoleTypeEnum {
     /**
      * 账号角色关联类型

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/workresume/constant/enums/WorkResumeEnableStateEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.workresume.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/23 4:16 下午
  **/
+@SwaggerDisplayEnum
 public enum WorkResumeEnableStateEnum {
     /**
      * 启用状态

+ 2 - 0
fm-person/src/main/java/com/persagy/fm/workresume/constant/enums/WorkResumeHiredStateEnum.java

@@ -1,5 +1,6 @@
 package com.persagy.fm.workresume.constant.enums;
 
+import com.persagy.fm.common.model.annotation.SwaggerDisplayEnum;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,6 +10,7 @@ import lombok.Setter;
  * @author lixing
  * @version V1.0 2021/3/23 4:16 下午
  **/
+@SwaggerDisplayEnum
 public enum WorkResumeHiredStateEnum {
     /**
      * 工作状态