ContiNew/continew-admin
1
1
Fork 0
mirror of https://github.com/continew-org/continew-admin.git synced 2025-09-12 05:01:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: 优化接口文档枚举参数显示效果

Browse Source
This commit is contained in:
Charles7c
2024-07-24 22:25:55 +08:00
parent 00c33226c8
commit 770fda3882
49 changed files with 144 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
continew-admin-system/src/main/java/top/continew/admin/auth/model/resp/UserInfoResp.java
View File

@@ -63,7 +63,7 @@ public class UserInfoResp implements Serializable {
/**
* 性别
*/
@Schema(description = "性别（0：未知；1：男；2：女）", type = "Integer", allowableValues = {"0", "1", "2"}, example = "1")
@Schema(description = "性别", example = "1")
private GenderEnum gender;
/**

5
continew-admin-system/src/main/java/top/continew/admin/system/enums/FileTypeEnum.java
View File

@@ -65,6 +65,11 @@ public enum FileTypeEnum implements IBaseEnum<Integer> {
private final String description;
private final List<String> extensions;
@Override
public String toString() {
return "%s: %s".formatted(this.value, this.description);
}
/**
* 根据扩展名查询
*

5
continew-admin-system/src/main/java/top/continew/admin/system/enums/ImportPolicyEnum.java
View File

@@ -51,6 +51,11 @@ public enum ImportPolicyEnum implements IBaseEnum<Integer> {
private final Integer value;
private final String description;
@Override
public String toString() {
return "%s: %s".formatted(this.value, this.description);
}
public boolean validate(ImportPolicyEnum importPolicy, String data, List<String> existList) {
return this == importPolicy && CollUtil.isNotEmpty(existList) && existList.contains(data);
}

5
continew-admin-system/src/main/java/top/continew/admin/system/enums/LogStatusEnum.java
View File

@@ -42,4 +42,9 @@ public enum LogStatusEnum implements IBaseEnum<Integer> {
private final Integer value;
private final String description;
@Override
public String toString() {
return "%s: %s".formatted(this.value, this.description);
}
}

5
continew-admin-system/src/main/java/top/continew/admin/system/enums/NoticeStatusEnum.java
View File

@@ -52,6 +52,11 @@ public enum NoticeStatusEnum implements IBaseEnum<Integer> {
private final String description;
private final String color;
@Override
public String toString() {
return "%s: %s".formatted(this.value, this.description);
}
/**
* 获取公告状态
*

5
continew-admin-system/src/main/java/top/continew/admin/system/enums/StorageTypeEnum.java
View File

@@ -42,4 +42,9 @@ public enum StorageTypeEnum implements IBaseEnum<Integer> {
private final Integer value;
private final String description;
@Override
public String toString() {
return "%s: %s".formatted(this.value, this.description);
}
}

2
continew-admin-system/src/main/java/top/continew/admin/system/model/req/DeptReq.java
View File

@@ -72,7 +72,7 @@ public class DeptReq extends BaseReq {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
/**

2
continew-admin-system/src/main/java/top/continew/admin/system/model/req/DictItemReq.java
View File

@@ -80,7 +80,7 @@ public class DictItemReq extends BaseReq {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
/**

4
continew-admin-system/src/main/java/top/continew/admin/system/model/req/MenuReq.java
View File

@@ -44,7 +44,7 @@ public class MenuReq extends BaseReq {
/**
* 类型
*/
@Schema(description = "类型（1：目录；2：菜单；3：按钮）", type = "Integer", allowableValues = {"1", "2", "3"}, example = "2")
@Schema(description = "类型", example = "2")
@NotNull(message = "类型非法")
private MenuTypeEnum type;
@@ -132,7 +132,7 @@ public class MenuReq extends BaseReq {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@NotNull(message = "状态非法")
private DisEnableStatusEnum status;
}

3
continew-admin-system/src/main/java/top/continew/admin/system/model/req/RoleReq.java
View File

@@ -82,8 +82,7 @@ public class RoleReq extends BaseReq {
/**
* 数据权限
*/
@Schema(description = "数据权限（1：全部数据权限；2：本部门及以下数据权限；3：本部门数据权限；4：仅本人数据权限；5：自定义数据权限）", type = "Integer", allowableValues = {
"1", "2", "3", "4", "5"}, example = "5")
@Schema(description = "数据权限", example = "5")
private DataScopeEnum dataScope;
/**

4
continew-admin-system/src/main/java/top/continew/admin/system/model/req/StorageReq.java
View File

@@ -62,7 +62,7 @@ public class StorageReq extends BaseReq {
/**
* 类型
*/
@Schema(description = "类型", type = "Integer", allowableValues = {"1", "2"}, example = "2")
@Schema(description = "类型", example = "2")
@NotNull(message = "类型非法")
private StorageTypeEnum type;
@@ -129,6 +129,6 @@ public class StorageReq extends BaseReq {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
}

2
continew-admin-system/src/main/java/top/continew/admin/system/model/req/UserBasicInfoUpdateReq.java
View File

@@ -51,7 +51,7 @@ public class UserBasicInfoUpdateReq implements Serializable {
/**
* 性别
*/
@Schema(description = "性别（0：未知；1：男；2：女）", type = "Integer", allowableValues = {"0", "1", "2"}, example = "1")
@Schema(description = "性别", example = "1")
@NotNull(message = "性别非法")
private GenderEnum gender;
}

8
continew-admin-system/src/main/java/top/continew/admin/system/model/req/UserImportReq.java
View File

@@ -49,27 +49,27 @@ public class UserImportReq extends BaseReq {
/**
* 用户重复策略
*/
@Schema(description = "重复用户策略", type = "Integer", allowableValues = {"1", "2", "3", "4"}, example = "1")
@Schema(description = "重复用户策略", example = "1")
@NotNull(message = "重复用户策略不能为空")
private ImportPolicyEnum duplicateUser;
/**
* 重复邮箱策略
*/
@Schema(description = "重复邮箱策略", type = "Integer", allowableValues = {"1", "2", "3", "4"}, example = "1")
@Schema(description = "重复邮箱策略", example = "1")
@NotNull(message = "重复邮箱策略不能为空")
private ImportPolicyEnum duplicateEmail;
/**
* 重复手机策略
*/
@Schema(description = "重复手机策略", type = "Integer", allowableValues = {"1", "2", "3", "4"}, example = "1")
@Schema(description = "重复手机策略", example = "1")
@NotNull(message = "重复手机策略不能为空")
private ImportPolicyEnum duplicatePhone;
/**
* 默认状态
*/
@Schema(description = "默认状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "默认状态", example = "1")
private DisEnableStatusEnum defaultStatus;
}

4
continew-admin-system/src/main/java/top/continew/admin/system/model/req/UserReq.java
View File

@@ -87,7 +87,7 @@ public class UserReq extends BaseReq {
/**
* 性别
*/
@Schema(description = "性别（0：未知；1：男；2：女）", type = "Integer", allowableValues = {"0", "1", "2"}, example = "1")
@Schema(description = "性别", example = "1")
@NotNull(message = "性别非法")
private GenderEnum gender;
@@ -115,6 +115,6 @@ public class UserReq extends BaseReq {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
}

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/DeptResp.java
View File

@@ -59,7 +59,7 @@ public class DeptResp extends BaseDetailResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@ExcelProperty(value = "状态", converter = ExcelBaseEnumConverter.class, order = 5)
private DisEnableStatusEnum status;

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/DictItemResp.java
View File

@@ -59,7 +59,7 @@ public class DictItemResp extends BaseDetailResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@ExcelProperty(value = "状态", converter = ExcelBaseEnumConverter.class)
private DisEnableStatusEnum status;

3
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/FileResp.java
View File

@@ -65,8 +65,7 @@ public class FileResp extends BaseDetailResp {
/**
* 类型
*/
@Schema(description = "类型（1：其他；2：图片；3：文档；4：视频；5：音频）", type = "Integer", allowableValues = {"1", "2", "3", "4",
"5"}, example = "2")
@Schema(description = "类型", example = "2")
private FileTypeEnum type;
/**

3
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/FileStatisticsResp.java
View File

@@ -42,8 +42,7 @@ public class FileStatisticsResp implements Serializable {
/**
* 文件类型
*/
@Schema(description = "类型（1：其他；2：图片；3：文档；4：视频；5：音频）", type = "Integer", allowableValues = {"1", "2", "3", "4",
"5"}, example = "2")
@Schema(description = "类型", example = "2")
private FileTypeEnum type;
/**

4
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/MenuResp.java
View File

@@ -54,7 +54,7 @@ public class MenuResp extends BaseResp {
/**
* 类型
*/
@Schema(description = "类型（1：目录；2：菜单；3：按钮）", type = "Integer", allowableValues = {"1", "2", "3"}, example = "2")
@Schema(description = "类型", example = "2")
private MenuTypeEnum type;
/**
@@ -120,6 +120,6 @@ public class MenuResp extends BaseResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
}

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/NoticeResp.java
View File

@@ -66,7 +66,7 @@ public class NoticeResp extends BaseResp {
*
* @return 公告状态
*/
@Schema(description = "状态（1：待发布；2：已发布；3：已过期）", type = "Integer", allowableValues = {"1", "2", "3"}, example = "1")
@Schema(description = "状态", example = "1")
public NoticeStatusEnum getStatus() {
return NoticeStatusEnum.getStatus(effectiveTime, terminateTime);
}

3
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/RoleDetailResp.java
View File

@@ -63,8 +63,7 @@ public class RoleDetailResp extends BaseDetailResp {
/**
* 数据权限
*/
@Schema(description = "数据权限（1：全部数据权限；2：本部门及以下数据权限；3：本部门数据权限；4：仅本人数据权限；5：自定义数据权限）", type = "Integer", allowableValues = {
"1", "2", "3", "4", "5"}, example = "5")
@Schema(description = "数据权限", example = "5")
@ExcelProperty(value = "数据权限", converter = ExcelBaseEnumConverter.class)
private DataScopeEnum dataScope;

3
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/RoleResp.java
View File

@@ -51,8 +51,7 @@ public class RoleResp extends BaseDetailResp {
/**
* 数据权限
*/
@Schema(description = "数据权限（1：全部数据权限；2：本部门及以下数据权限；3：本部门数据权限；4：仅本人数据权限；5：自定义数据权限）", type = "Integer", allowableValues = {
"1", "2", "3", "4", "5"}, example = "5")
@Schema(description = "数据权限", example = "5")
private DataScopeEnum dataScope;
/**

4
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/StorageResp.java
View File

@@ -53,13 +53,13 @@ public class StorageResp extends BaseDetailResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
/**
* 类型
*/
@Schema(description = "类型（1：兼容S3协议存储；2：本地存储）", type = "Integer", allowableValues = {"1", "2"}, example = "2")
@Schema(description = "类型", example = "2")
private StorageTypeEnum type;
/**

4
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/UserDetailResp.java
View File

@@ -73,14 +73,14 @@ public class UserDetailResp extends BaseDetailResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@ExcelProperty(value = "状态", converter = ExcelBaseEnumConverter.class, order = 4)
private DisEnableStatusEnum status;
/**
* 性别
*/
@Schema(description = "性别（0：未知；1：男；2：女）", type = "Integer", allowableValues = {"0", "1", "2"}, example = "1")
@Schema(description = "性别", example = "1")
@ExcelProperty(value = "性别", converter = ExcelBaseEnumConverter.class, order = 5)
private GenderEnum gender;

4
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/UserResp.java
View File

@@ -61,7 +61,7 @@ public class UserResp extends BaseDetailResp {
/**
* 性别
*/
@Schema(description = "性别（0：未知；1：男；2：女）", type = "Integer", allowableValues = {"0", "1", "2"}, example = "1")
@Schema(description = "性别", example = "1")
private GenderEnum gender;
/**
@@ -87,7 +87,7 @@ public class UserResp extends BaseDetailResp {
/**
* 状态
*/
@Schema(description = "状态（1：启用；2：禁用）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private DisEnableStatusEnum status;
/**

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/log/LogDetailResp.java
View File

@@ -140,7 +140,7 @@ public class LogDetailResp implements Serializable {
/**
* 状态
*/
@Schema(description = "状态（1：成功；2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private LogStatusEnum status;
/**

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/log/LogResp.java
View File

@@ -89,7 +89,7 @@ public class LogResp implements Serializable {
/**
* 状态
*/
@Schema(description = "状态（1：成功；2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
private LogStatusEnum status;
/**

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/log/LoginLogExportResp.java
View File

@@ -72,7 +72,7 @@ public class LoginLogExportResp implements Serializable {
/**
* 状态
*/
@Schema(description = "状态（1：成功；2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@ExcelProperty(value = "状态", converter = ExcelBaseEnumConverter.class)
private LogStatusEnum status;

2
continew-admin-system/src/main/java/top/continew/admin/system/model/resp/log/OperationLogExportResp.java
View File

@@ -79,7 +79,7 @@ public class OperationLogExportResp implements Serializable {
/**
* 状态
*/
@Schema(description = "状态（1：成功；2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
@Schema(description = "状态", example = "1")
@ExcelProperty(value = "状态", converter = ExcelBaseEnumConverter.class)
private LogStatusEnum status;