feat: knife4j springdoc

This commit is contained in:
xingyu
2022-12-22 00:25:22 +08:00
parent 69420c0a9c
commit cacefb4eea
385 changed files with 1939 additions and 1941 deletions

View File

@@ -6,15 +6,15 @@ import lombok.Data;
import javax.validation.constraints.NotNull;
import java.util.List;
@Schema(title = "管理后台 - 基于数据库的表结构,创建代码生成器的表和字段定义 Request VO")
@Schema(description = "管理后台 - 基于数据库的表结构,创建代码生成器的表和字段定义 Request VO")
@Data
public class CodegenCreateListReqVO {
@Schema(title = "数据源配置的编号", required = true, example = "1")
@Schema(description = "数据源配置的编号", required = true, example = "1")
@NotNull(message = "数据源配置的编号不能为空")
private Long dataSourceConfigId;
@Schema(title = "表名数组", required = true, example = "[1, 2, 3]")
@Schema(description = "表名数组", required = true, example = "[1, 2, 3]")
@NotNull(message = "表名数组不能为空")
private List<String> tableNames;

View File

@@ -7,14 +7,14 @@ import lombok.Data;
import java.util.List;
@Schema(title = "管理后台 - 代码生成表和字段的明细 Response VO")
@Schema(description = "管理后台 - 代码生成表和字段的明细 Response VO")
@Data
public class CodegenDetailRespVO {
@Schema(name = "表定义")
@Schema(description = "表定义")
private CodegenTableRespVO table;
@Schema(name = "字段定义")
@Schema(description = "字段定义")
private List<CodegenColumnRespVO> columns;
}

View File

@@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.infra.controller.admin.codegen.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 代码生成预览 Response VO", description ="注意,每个文件都是一个该对象")
@Schema(description = "管理后台 - 代码生成预览 Response VO,注意,每个文件都是一个该对象")
@Data
public class CodegenPreviewRespVO {
@Schema(title = "文件路径", required = true, example = "java/cn/iocoder/yudao/adminserver/modules/system/controller/test/SysTestDemoController.java")
@Schema(description = "文件路径", required = true, example = "java/cn/iocoder/yudao/adminserver/modules/system/controller/test/SysTestDemoController.java")
private String filePath;
@Schema(title = "代码", required = true, example = "Hello World")
@Schema(description = "代码", required = true, example = "Hello World")
private String code;
}

View File

@@ -14,7 +14,7 @@ import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotNull;
import java.util.List;
@Schema(title = "管理后台 - 代码生成表和字段的修改 Request VO")
@Schema(description = "管理后台 - 代码生成表和字段的修改 Request VO")
@Data
public class CodegenUpdateReqVO {
@@ -26,14 +26,14 @@ public class CodegenUpdateReqVO {
@NotNull(message = "字段定义不能为空")
private List<Column> columns;
@Schema(title = "更新表定义")
@Schema(description = "更新表定义")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Valid
public static class Table extends CodegenTableBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
private Long id;
@AssertTrue(message = "上级菜单不能为空")
@@ -45,13 +45,13 @@ public class CodegenUpdateReqVO {
}
@Schema(title = "更新表定义")
@Schema(description = "更新表定义")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public static class Column extends CodegenColumnBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
private Long id;
}

View File

@@ -11,73 +11,73 @@ import javax.validation.constraints.NotNull;
@Data
public class CodegenColumnBaseVO {
@Schema(title = "表编号", required = true, example = "1")
@Schema(description = "表编号", required = true, example = "1")
@NotNull(message = "表编号不能为空")
private Long tableId;
@Schema(title = "字段名", required = true, example = "user_age")
@Schema(description = "字段名", required = true, example = "user_age")
@NotNull(message = "字段名不能为空")
private String columnName;
@Schema(title = "字段类型", required = true, example = "int(11)")
@Schema(description = "字段类型", required = true, example = "int(11)")
@NotNull(message = "字段类型不能为空")
private String dataType;
@Schema(title = "字段描述", required = true, example = "年龄")
@Schema(description = "字段描述", required = true, example = "年龄")
@NotNull(message = "字段描述不能为空")
private String columnComment;
@Schema(title = "是否允许为空", required = true, example = "true")
@Schema(description = "是否允许为空", required = true, example = "true")
@NotNull(message = "是否允许为空不能为空")
private Boolean nullable;
@Schema(title = "是否主键", required = true, example = "false")
@Schema(description = "是否主键", required = true, example = "false")
@NotNull(message = "是否主键不能为空")
private Boolean primaryKey;
@Schema(title = "是否自增", required = true, example = "true")
@Schema(description = "是否自增", required = true, example = "true")
@NotNull(message = "是否自增不能为空")
private String autoIncrement;
@Schema(title = "排序", required = true, example = "10")
@Schema(description = "排序", required = true, example = "10")
@NotNull(message = "排序不能为空")
private Integer ordinalPosition;
@Schema(title = "Java 属性类型", required = true, example = "userAge")
@Schema(description = "Java 属性类型", required = true, example = "userAge")
@NotNull(message = "Java 属性类型不能为空")
private String javaType;
@Schema(title = "Java 属性名", required = true, example = "Integer")
@Schema(description = "Java 属性名", required = true, example = "Integer")
@NotNull(message = "Java 属性名不能为空")
private String javaField;
@Schema(title = "字典类型", example = "sys_gender")
@Schema(description = "字典类型", example = "sys_gender")
private String dictType;
@Schema(title = "数据示例", example = "1024")
@Schema(description = "数据示例", example = "1024")
private String example;
@Schema(title = "是否为 Create 创建操作的字段", required = true, example = "true")
@Schema(description = "是否为 Create 创建操作的字段", required = true, example = "true")
@NotNull(message = "是否为 Create 创建操作的字段不能为空")
private Boolean createOperation;
@Schema(title = "是否为 Update 更新操作的字段", required = true, example = "false")
@Schema(description = "是否为 Update 更新操作的字段", required = true, example = "false")
@NotNull(message = "是否为 Update 更新操作的字段不能为空")
private Boolean updateOperation;
@Schema(title = "是否为 List 查询操作的字段", required = true, example = "true")
@Schema(description = "是否为 List 查询操作的字段", required = true, example = "true")
@NotNull(message = "是否为 List 查询操作的字段不能为空")
private Boolean listOperation;
@Schema(title = "List 查询操作的条件类型", required = true, example = "LIKE", description = "参见 CodegenColumnListConditionEnum 枚举")
@Schema(description = "List 查询操作的条件类型,参见 CodegenColumnListConditionEnum 枚举", required = true, example = "LIKE")
@NotNull(message = "List 查询操作的条件类型不能为空")
private String listOperationCondition;
@Schema(title = "是否为 List 查询操作的返回字段", required = true, example = "true")
@Schema(description = "是否为 List 查询操作的返回字段", required = true, example = "true")
@NotNull(message = "是否为 List 查询操作的返回字段不能为空")
private Boolean listOperationResult;
@Schema(title = "显示类型", required = true, example = "input")
@Schema(description = "显示类型", required = true, example = "input")
@NotNull(message = "显示类型不能为空")
private String htmlType;

View File

@@ -7,16 +7,16 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 代码生成字段定义 Response VO")
@Schema(description = "管理后台 - 代码生成字段定义 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class CodegenColumnRespVO extends CodegenColumnBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
private Long id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -5,52 +5,52 @@ import lombok.Data;
import javax.validation.constraints.NotNull;
/**
* 代码生成 Base VO提供给添加、修改、详细的子 VO 使用
* 如果子 VO 存在差异的字段,请不要添加到这里,影响 Swagger 文档生成
*/
* 代码生成 Base VO提供给添加、修改、详细的子 VO 使用
* 如果子 VO 存在差异的字段,请不要添加到这里,影响 Swagger 文档生成
*/
@Data
public class CodegenTableBaseVO {
@Schema(title = "生成场景", required = true, example = "1", description = "参见 CodegenSceneEnum 枚举")
@Schema(description = "生成场景,参见 CodegenSceneEnum 枚举", required = true, example = "1")
@NotNull(message = "导入类型不能为空")
private Integer scene;
@Schema(title = "表名称", required = true, example = "yudao")
@Schema(description = "表名称", required = true, example = "yudao")
@NotNull(message = "表名称不能为空")
private String tableName;
@Schema(title = "表描述", required = true, example = "芋道")
@Schema(description = "表描述", required = true, example = "芋道")
@NotNull(message = "表描述不能为空")
private String tableComment;
@Schema(title = "备注", example = "我是备注")
@Schema(description = "备注", example = "我是备注")
private String remark;
@Schema(title = "模块名", required = true, example = "system")
@Schema(description = "模块名", required = true, example = "system")
@NotNull(message = "模块名不能为空")
private String moduleName;
@Schema(title = "业务名", required = true, example = "codegen")
@Schema(description = "业务名", required = true, example = "codegen")
@NotNull(message = "业务名不能为空")
private String businessName;
@Schema(title = "类名称", required = true, example = "CodegenTable")
@Schema(description = "类名称", required = true, example = "CodegenTable")
@NotNull(message = "类名称不能为空")
private String className;
@Schema(title = "类描述", required = true, example = "代码生成器的表定义")
@Schema(description = "类描述", required = true, example = "代码生成器的表定义")
@NotNull(message = "类描述不能为空")
private String classComment;
@Schema(title = "作者", required = true, example = "芋道源码")
@Schema(description = "作者", required = true, example = "芋道源码")
@NotNull(message = "作者不能为空")
private String author;
@Schema(title = "模板类型", required = true, example = "1", description = "参见 CodegenTemplateTypeEnum 枚举")
@Schema(description = "模板类型,参见 CodegenTemplateTypeEnum 枚举", required = true, example = "1")
@NotNull(message = "模板类型不能为空")
private Integer templateType;
@Schema(title = "父菜单编号", example = "1024")
@Schema(description = "父菜单编号", example = "1024")
private Long parentMenuId;
}

View File

@@ -11,19 +11,19 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 表定义分页 Request VO")
@Schema(description = "管理后台 - 表定义分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class CodegenTablePageReqVO extends PageParam {
@Schema(title = "表名称", example = "yudao", description = "模糊匹配")
@Schema(description = "表名称,模糊匹配", example = "yudao")
private String tableName;
@Schema(title = "表描述", example = "芋道", description = "模糊匹配")
@Schema(description = "表描述,模糊匹配", example = "芋道")
private String tableComment;
@Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@Schema(description = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;

View File

@@ -7,22 +7,22 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 代码生成表定义 Response VO")
@Schema(description = "管理后台 - 代码生成表定义 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class CodegenTableRespVO extends CodegenTableBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
private Long id;
@Schema(title = "主键编号", required = true, example = "1024")
@Schema(description = "主键编号", required = true, example = "1024")
private Integer dataSourceConfigId;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
@Schema(title = "更新时间", required = true)
@Schema(description = "更新时间", required = true)
private LocalDateTime updateTime;
}

View File

@@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.infra.controller.admin.codegen.vo.table;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 数据库的表定义 Response VO")
@Schema(description = "管理后台 - 数据库的表定义 Response VO")
@Data
public class DatabaseTableRespVO {
@Schema(title = "表名称", required = true, example = "yuanma")
@Schema(description = "表名称", required = true, example = "yuanma")
private String name;
@Schema(title = "表描述", required = true, example = "芋道源码")
@Schema(description = "表描述", required = true, example = "芋道源码")
private String comment;
}

View File

@@ -14,26 +14,26 @@ import javax.validation.constraints.Size;
@Data
public class ConfigBaseVO {
@Schema(title = "参数分组", required = true, example = "biz")
@Schema(description = "参数分组", required = true, example = "biz")
@NotEmpty(message = "参数分组不能为空")
@Size(max = 50, message = "参数名称不能超过50个字符")
private String category;
@Schema(title = "参数名称", required = true, example = "数据库名")
@Schema(description = "参数名称", required = true, example = "数据库名")
@NotBlank(message = "参数名称不能为空")
@Size(max = 100, message = "参数名称不能超过100个字符")
private String name;
@Schema(title = "参数键值", required = true, example = "1024")
@Schema(description = "参数键值", required = true, example = "1024")
@NotBlank(message = "参数键值不能为空")
@Size(max = 500, message = "参数键值长度不能超过500个字符")
private String value;
@Schema(title = "是否敏感", required = true, example = "true")
@Schema(description = "是否敏感", required = true, example = "true")
@NotNull(message = "是否敏感不能为空")
private Boolean visible;
@Schema(title = "备注", example = "备注一下很帅气!")
@Schema(description = "备注", example = "备注一下很帅气!")
private String remark;
}

View File

@@ -7,12 +7,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
@Schema(title = "管理后台 - 参数配置创建 Request VO")
@Schema(description = "管理后台 - 参数配置创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class ConfigCreateReqVO extends ConfigBaseVO {
@Schema(title = "参数键名", required = true, example = "yunai.db.username")
@Schema(description = "参数键名", required = true, example = "yunai.db.username")
@NotBlank(message = "参数键名长度不能为空")
@Size(max = 100, message = "参数键名长度不能超过100个字符")
private String key;

View File

@@ -8,20 +8,20 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 参数配置导出 Request VO")
@Schema(description = "管理后台 - 参数配置导出 Request VO")
@Data
public class ConfigExportReqVO {
@Schema(title = "参数名称", example = "模糊匹配")
@Schema(description = "参数名称", example = "模糊匹配")
private String name;
@Schema(title = "参数键名", example = "yunai.db.username", description = "模糊匹配")
@Schema(description = "参数键名,模糊匹配", example = "yunai.db.username")
private String key;
@Schema(title = "参数类型", example = "1", description = "参见 SysConfigTypeEnum 枚举")
@Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1")
private Integer type;
@Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@Schema(description = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;

View File

@@ -11,22 +11,22 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 参数配置分页 Request VO")
@Schema(description = "管理后台 - 参数配置分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ConfigPageReqVO extends PageParam {
@Schema(title = "数据源名称", example = "模糊匹配")
@Schema(description = "数据源名称,模糊匹配", example = "名称")
private String name;
@Schema(title = "参数键名", example = "yunai.db.username", description = "模糊匹配")
@Schema(description = "参数键名,模糊匹配", example = "yunai.db.username")
private String key;
@Schema(title = "参数类型", example = "1", description = "参见 SysConfigTypeEnum 枚举")
@Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1")
private Integer type;
@Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@Schema(description = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;

View File

@@ -8,23 +8,23 @@ import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 参数配置信息 Response VO")
@Schema(description = "管理后台 - 参数配置信息 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class ConfigRespVO extends ConfigBaseVO {
@Schema(title = "参数配置序号", required = true, example = "1024")
@Schema(description = "参数配置序号", required = true, example = "1024")
private Long id;
@Schema(title = "参数键名", required = true, example = "yunai.db.username")
@Schema(description = "参数键名", required = true, example = "yunai.db.username")
@NotBlank(message = "参数键名长度不能为空")
@Size(max = 100, message = "参数键名长度不能超过100个字符")
private String key;
@Schema(title = "参数类型", required = true, example = "1", description = "参见 SysConfigTypeEnum 枚举")
@Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", required = true, example = "1")
private Integer type;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -7,13 +7,13 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 参数配置创建 Request VO")
@Schema(description = "管理后台 - 参数配置创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ConfigUpdateReqVO extends ConfigBaseVO {
@Schema(title = "参数配置序号", required = true, example = "1024")
@Schema(description = "参数配置序号", required = true, example = "1024")
@NotNull(message = "参数配置编号不能为空")
private Long id;

View File

@@ -10,15 +10,15 @@ import javax.validation.constraints.*;
@Data
public class DataSourceConfigBaseVO {
@Schema(title = "数据源名称", required = true, example = "test")
@Schema(description = "数据源名称", required = true, example = "test")
@NotNull(message = "数据源名称不能为空")
private String name;
@Schema(title = "数据源连接", required = true, example = "jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro")
@Schema(description = "数据源连接", required = true, example = "jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro")
@NotNull(message = "数据源连接不能为空")
private String url;
@Schema(title = "用户名", required = true, example = "root")
@Schema(description = "用户名", required = true, example = "root")
@NotNull(message = "用户名不能为空")
private String username;

View File

@@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import javax.validation.constraints.*;
@Schema(title = "管理后台 - 数据源配置创建 Request VO")
@Schema(description = "管理后台 - 数据源配置创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class DataSourceConfigCreateReqVO extends DataSourceConfigBaseVO {
@Schema(title = "密码", required = true, example = "123456")
@Schema(description = "密码", required = true, example = "123456")
@NotNull(message = "密码不能为空")
private String password;

View File

@@ -4,16 +4,16 @@ import lombok.*;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 数据源配置 Response VO")
@Schema(description = "管理后台 - 数据源配置 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class DataSourceConfigRespVO extends DataSourceConfigBaseVO {
@Schema(title = "主键编号", required = true, example = "1024")
@Schema(description = "主键编号", required = true, example = "1024")
private Integer id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -3,17 +3,17 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import javax.validation.constraints.*;
@Schema(title = "管理后台 - 数据源配置更新 Request VO")
@Schema(description = "管理后台 - 数据源配置更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class DataSourceConfigUpdateReqVO extends DataSourceConfigBaseVO {
@Schema(title = "主键编号", required = true, example = "1024")
@Schema(description = "主键编号", required = true, example = "1024")
@NotNull(message = "主键编号不能为空")
private Long id;
@Schema(title = "密码", required = true, example = "123456")
@Schema(description = "密码", required = true, example = "123456")
@NotNull(message = "密码不能为空")
private String password;

View File

@@ -11,11 +11,11 @@ import javax.validation.constraints.NotNull;
@Data
public class FileConfigBaseVO {
@Schema(title = "配置名", required = true, example = "S3 - 阿里云")
@Schema(description = "配置名", required = true, example = "S3 - 阿里云")
@NotNull(message = "配置名不能为空")
private String name;
@Schema(title = "备注", example = "我是备注")
@Schema(description = "备注", example = "我是备注")
private String remark;
}

View File

@@ -8,17 +8,17 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
import java.util.Map;
@Schema(title = "管理后台 - 文件配置创建 Request VO")
@Schema(description = "管理后台 - 文件配置创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class FileConfigCreateReqVO extends FileConfigBaseVO {
@Schema(title = "存储器", required = true, example = "1", description = "参见 FileStorageEnum 枚举类")
@Schema(description = "存储器,参见 FileStorageEnum 枚举类参见 FileStorageEnum 枚举类", required = true, example = "1")
@NotNull(message = "存储器不能为空")
private Integer storage;
@Schema(title = "存储配置", required = true, description = "配置是动态参数,所以使用 Map 接收")
@Schema(description = "存储配置,配置是动态参数,所以使用 Map 接收", required = true)
@NotNull(message = "存储配置不能为空")
private Map<String, Object> config;

View File

@@ -11,20 +11,20 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 文件配置分页 Request VO")
@Schema(description = "管理后台 - 文件配置分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class FileConfigPageReqVO extends PageParam {
@Schema(title = "配置名", example = "S3 - 阿里云")
@Schema(description = "配置名", example = "S3 - 阿里云")
private String name;
@Schema(title = "存储器", example = "1")
@Schema(description = "存储器", example = "1")
private Integer storage;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -9,27 +9,27 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 文件配置 Response VO")
@Schema(description = "管理后台 - 文件配置 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class FileConfigRespVO extends FileConfigBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
private Long id;
@Schema(title = "存储器", required = true, example = "1", description = "参见 FileStorageEnum 枚举类")
@Schema(description = "存储器,参见 FileStorageEnum 枚举类", required = true, example = "1")
@NotNull(message = "存储器不能为空")
private Integer storage;
@Schema(title = "是否为主配置", required = true, example = "true")
@Schema(description = "是否为主配置", required = true, example = "true")
@NotNull(message = "是否为主配置不能为空")
private Boolean master;
@Schema(title = "存储配置", required = true)
@Schema(description = "存储配置", required = true)
private FileClientConfig config;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -8,17 +8,17 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
import java.util.Map;
@Schema(title = "管理后台 - 文件配置更新 Request VO")
@Schema(description = "管理后台 - 文件配置更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class FileConfigUpdateReqVO extends FileConfigBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
@NotNull(message = "编号不能为空")
private Long id;
@Schema(title = "存储配置", required = true, description = "配置是动态参数,所以使用 Map 接收")
@Schema(description = "存储配置,配置是动态参数,所以使用 Map 接收", required = true)
@NotNull(message = "存储配置不能为空")
private Map<String, Object> config;

View File

@@ -11,20 +11,20 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 文件分页 Request VO")
@Schema(description = "管理后台 - 文件分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class FilePageReqVO extends PageParam {
@Schema(title = "文件路径", example = "yudao", description = "模糊匹配")
@Schema(description = "文件路径,模糊匹配", example = "yudao")
private String path;
@Schema(title = "文件类型", example = "application/octet-stream", description = "模糊匹配")
@Schema(description = "文件类型,模糊匹配", example = "application/octet-stream")
private String type;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -5,32 +5,32 @@ import lombok.Data;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 文件 Response VO", description = "不返回 content 字段,太大")
@Schema(description = "管理后台 - 文件 Response VO,不返回 content 字段,太大")
@Data
public class FileRespVO {
@Schema(title = "文件编号", required = true, example = "1024")
@Schema(description = "文件编号", required = true, example = "1024")
private Long id;
@Schema(title = "配置编号", required = true, example = "11")
@Schema(description = "配置编号", required = true, example = "11")
private Long configId;
@Schema(title = "文件路径", required = true, example = "yudao.jpg")
@Schema(description = "文件路径", required = true, example = "yudao.jpg")
private String path;
@Schema(title = "原文件名", required = true, example = "yudao.jpg")
@Schema(description = "原文件名", required = true, example = "yudao.jpg")
private String name;
@Schema(title = "文件 URL", required = true, example = "https://www.iocoder.cn/yudao.jpg")
@Schema(description = "文件 URL", required = true, example = "https://www.iocoder.cn/yudao.jpg")
private String url;
@Schema(title = "文件MIME类型", example = "application/octet-stream")
@Schema(description = "文件MIME类型", example = "application/octet-stream")
private String type;
@Schema(title = "文件大小", example = "2048", required = true)
@Schema(description = "文件大小", example = "2048", required = true)
private Integer size;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -6,15 +6,15 @@ import org.springframework.web.multipart.MultipartFile;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 上传文件 Request VO")
@Schema(description = "管理后台 - 上传文件 Request VO")
@Data
public class FileUploadReqVO {
@Schema(title = "文件附件", required = true)
@Schema(description = "文件附件", required = true)
@NotNull(message = "文件附件不能为空")
private MultipartFile file;
@Schema(title = "文件附件", example = "yudaoyuanma.png")
@Schema(description = "文件附件", example = "yudaoyuanma.png")
private String path;
}

View File

@@ -11,26 +11,26 @@ import javax.validation.constraints.NotNull;
@Data
public class JobBaseVO {
@Schema(title = "任务名称", required = true, example = "测试任务")
@Schema(description = "任务名称", required = true, example = "测试任务")
@NotNull(message = "任务名称不能为空")
private String name;
@Schema(title = "处理器的参数", example = "yudao")
@Schema(description = "处理器的参数", example = "yudao")
private String handlerParam;
@Schema(title = "CRON 表达式", required = true, example = "0/10 * * * * ? *")
@Schema(description = "CRON 表达式", required = true, example = "0/10 * * * * ? *")
@NotNull(message = "CRON 表达式不能为空")
private String cronExpression;
@Schema(title = "重试次数", required = true, example = "3")
@Schema(description = "重试次数", required = true, example = "3")
@NotNull(message = "重试次数不能为空")
private Integer retryCount;
@Schema(title = "重试间隔", required = true, example = "1000")
@Schema(description = "重试间隔", required = true, example = "1000")
@NotNull(message = "重试间隔不能为空")
private Integer retryInterval;
@Schema(title = "监控超时时间", example = "1000")
@Schema(description = "监控超时时间", example = "1000")
private Integer monitorTimeout;
}

View File

@@ -7,13 +7,13 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 定时任务创建 Request VO")
@Schema(description = "管理后台 - 定时任务创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobCreateReqVO extends JobBaseVO {
@Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@NotNull(message = "处理器的名字不能为空")
private String handlerName;

View File

@@ -3,17 +3,17 @@ package cn.iocoder.yudao.module.infra.controller.admin.job.vo.job;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 定时任务 Excel 导出 Request VO", description = "参数和 JobPageReqVO 是一致的")
@Schema(description = "管理后台 - 定时任务 Excel 导出 Request VO-参数和 JobPageReqVO 是一致的")
@Data
public class JobExportReqVO {
@Schema(title = "任务名称", example = "测试任务", description = "模糊匹配")
@Schema(description = "任务名称-模糊匹配", example = "测试任务")
private String name;
@Schema(title = "任务状态", example = "1", description = "参见 JobStatusEnum 枚举")
@Schema(description = "任务状态-参见 JobStatusEnum 枚举", example = "1")
private Integer status;
@Schema(title = "处理器的名字", example = "UserSessionTimeoutJob", description = "模糊匹配")
@Schema(description = "处理器的名字-模糊匹配", example = "UserSessionTimeoutJob")
private String handlerName;
}

View File

@@ -6,19 +6,19 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 定时任务分页 Request VO")
@Schema(description = "管理后台 - 定时任务分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobPageReqVO extends PageParam {
@Schema(title = "任务名称", example = "测试任务", description = "模糊匹配")
@Schema(description = "任务名称,模糊匹配", example = "测试任务")
private String name;
@Schema(title = "任务状态", example = "1", description = "参见 JobStatusEnum 枚举")
@Schema(description = "任务状态,参见 JobStatusEnum 枚举", example = "1")
private Integer status;
@Schema(title = "处理器的名字", example = "sysUserSessionTimeoutJob", description = "模糊匹配")
@Schema(description = "处理器的名字,模糊匹配", example = "sysUserSessionTimeoutJob")
private String handlerName;
}

View File

@@ -8,23 +8,23 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 定时任务 Response VO")
@Schema(description = "管理后台 - 定时任务 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobRespVO extends JobBaseVO {
@Schema(title = "任务编号", required = true, example = "1024")
@Schema(description = "任务编号", required = true, example = "1024")
private Long id;
@Schema(title = "任务状态", required = true, example = "1")
@Schema(description = "任务状态", required = true, example = "1")
private Integer status;
@Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@NotNull(message = "处理器的名字不能为空")
private String handlerName;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -7,13 +7,13 @@ import lombok.ToString;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 定时任务更新 Request VO")
@Schema(description = "管理后台 - 定时任务更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobUpdateReqVO extends JobBaseVO {
@Schema(title = "任务编号", required = true, example = "1024")
@Schema(description = "任务编号", required = true, example = "1024")
@NotNull(message = "任务编号不能为空")
private Long id;

View File

@@ -15,38 +15,38 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@Data
public class JobLogBaseVO {
@Schema(title = "任务编号", required = true, example = "1024")
@Schema(description = "任务编号", required = true, example = "1024")
@NotNull(message = "任务编号不能为空")
private Long jobId;
@Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob")
@NotNull(message = "处理器的名字不能为空")
private String handlerName;
@Schema(title = "处理器的参数", example = "yudao")
@Schema(description = "处理器的参数", example = "yudao")
private String handlerParam;
@Schema(title = "第几次执行", required = true, example = "1")
@Schema(description = "第几次执行", required = true, example = "1")
@NotNull(message = "第几次执行不能为空")
private Integer executeIndex;
@Schema(title = "开始执行时间", required = true)
@Schema(description = "开始执行时间", required = true)
@NotNull(message = "开始执行时间不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime beginTime;
@Schema(title = "结束执行时间")
@Schema(description = "结束执行时间")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime endTime;
@Schema(title = "执行时长", example = "123")
@Schema(description = "执行时长", example = "123")
private Integer duration;
@Schema(title = "任务状态", required = true, example = "1", description = "参见 JobLogStatusEnum 枚举")
@Schema(description = "任务状态,参见 JobLogStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "任务状态不能为空")
private Integer status;
@Schema(title = "结果数据", example = "执行成功")
@Schema(description = "结果数据", example = "执行成功")
private String result;
}

View File

@@ -8,25 +8,25 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 定时任务 Excel 导出 Request VO", description = "参数和 JobLogPageReqVO 是一致的")
@Schema(description = "管理后台 - 定时任务 Excel 导出 Request VO,参数和 JobLogPageReqVO 是一致的")
@Data
public class JobLogExportReqVO {
@Schema(title = "任务编号", example = "10")
@Schema(description = "任务编号", example = "10")
private Long jobId;
@Schema(title = "处理器的名字", description = "模糊匹配")
@Schema(description = "处理器的名字,模糊匹配")
private String handlerName;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始执行时间")
@Schema(description = "开始执行时间")
private LocalDateTime beginTime;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "结束执行时间")
@Schema(description = "结束执行时间")
private LocalDateTime endTime;
@Schema(title = "任务状态", description = "参见 JobLogStatusEnum 枚举")
@Schema(description = "任务状态,参见 JobLogStatusEnum 枚举")
private Integer status;
}

View File

@@ -11,27 +11,27 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 定时任务日志分页 Request VO")
@Schema(description = "管理后台 - 定时任务日志分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobLogPageReqVO extends PageParam {
@Schema(title = "任务编号", example = "10")
@Schema(description = "任务编号", example = "10")
private Long jobId;
@Schema(title = "处理器的名字", description = "模糊匹配")
@Schema(description = "处理器的名字,模糊匹配")
private String handlerName;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始执行时间")
@Schema(description = "开始执行时间")
private LocalDateTime beginTime;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "结束执行时间")
@Schema(description = "结束执行时间")
private LocalDateTime endTime;
@Schema(title = "任务状态", description = "参见 JobLogStatusEnum 枚举")
@Schema(description = "任务状态,参见 JobLogStatusEnum 枚举")
private Integer status;
}

View File

@@ -7,16 +7,16 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 定时任务日志 Response VO")
@Schema(description = "管理后台 - 定时任务日志 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class JobLogRespVO extends JobLogBaseVO {
@Schema(title = "日志编号", required = true, example = "1024")
@Schema(description = "日志编号", required = true, example = "1024")
private Long id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -15,60 +15,60 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@Data
public class ApiAccessLogBaseVO {
@Schema(title = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002")
@Schema(description = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002")
@NotNull(message = "链路追踪编号不能为空")
private String traceId;
@Schema(title = "用户编号", required = true, example = "666")
@Schema(description = "用户编号", required = true, example = "666")
@NotNull(message = "用户编号不能为空")
private Long userId;
@Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
@NotNull(message = "用户类型不能为空")
private Integer userType;
@Schema(title = "应用名", required = true, example = "dashboard")
@Schema(description = "应用名", required = true, example = "dashboard")
@NotNull(message = "应用名不能为空")
private String applicationName;
@Schema(title = "请求方法名", required = true, example = "GET")
@Schema(description = "请求方法名", required = true, example = "GET")
@NotNull(message = "请求方法名不能为空")
private String requestMethod;
@Schema(title = "请求地址", required = true, example = "/xxx/yyy")
@Schema(description = "请求地址", required = true, example = "/xxx/yyy")
@NotNull(message = "请求地址不能为空")
private String requestUrl;
@Schema(title = "请求参数")
@Schema(description = "请求参数")
private String requestParams;
@Schema(title = "用户 IP", required = true, example = "127.0.0.1")
@Schema(description = "用户 IP", required = true, example = "127.0.0.1")
@NotNull(message = "用户 IP不能为空")
private String userIp;
@Schema(title = "浏览器 UA", required = true, example = "Mozilla/5.0")
@Schema(description = "浏览器 UA", required = true, example = "Mozilla/5.0")
@NotNull(message = "浏览器 UA不能为空")
private String userAgent;
@Schema(title = "开始请求时间", required = true)
@Schema(description = "开始请求时间", required = true)
@NotNull(message = "开始请求时间不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime beginTime;
@Schema(title = "结束请求时间", required = true)
@Schema(description = "结束请求时间", required = true)
@NotNull(message = "结束请求时间不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime endTime;
@Schema(title = "执行时长", required = true, example = "100")
@Schema(description = "执行时长", required = true, example = "100")
@NotNull(message = "执行时长不能为空")
private Integer duration;
@Schema(title = "结果码", required = true, example = "0")
@Schema(description = "结果码", required = true, example = "0")
@NotNull(message = "结果码不能为空")
private Integer resultCode;
@Schema(title = "结果提示", example = "芋道源码,牛逼!")
@Schema(description = "结果提示", example = "芋道源码,牛逼!")
private String resultMsg;
}

View File

@@ -8,30 +8,30 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - API 访问日志 Excel 导出 Request VO", description = "参数和 ApiAccessLogPageReqVO 是一致的")
@Schema(description = "管理后台 - API 访问日志 Excel 导出 Request VO,参数和 ApiAccessLogPageReqVO 是一致的")
@Data
public class ApiAccessLogExportReqVO {
@Schema(title = "用户编号", example = "666")
@Schema(description = "用户编号", example = "666")
private Long userId;
@Schema(title = "用户类型", example = "2")
@Schema(description = "用户类型", example = "2")
private Integer userType;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "请求地址", example = "/xxx/yyy", description = "模糊匹配")
@Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy")
private String requestUrl;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始请求时间")
@Schema(description = "开始请求时间")
private LocalDateTime[] beginTime;
@Schema(title = "执行时长", example = "100", description = "大于等于,单位:毫秒")
@Schema(description = "执行时长,大于等于,单位:毫秒", example = "100")
private Integer duration;
@Schema(title = "结果码", example = "0")
@Schema(description = "结果码", example = "0")
private Integer resultCode;
}

View File

@@ -11,32 +11,32 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - API 访问日志分页 Request VO")
@Schema(description = "管理后台 - API 访问日志分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ApiAccessLogPageReqVO extends PageParam {
@Schema(title = "用户编号", example = "666")
@Schema(description = "用户编号", example = "666")
private Long userId;
@Schema(title = "用户类型", example = "2")
@Schema(description = "用户类型", example = "2")
private Integer userType;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "请求地址", example = "/xxx/yyy", description = "模糊匹配")
@Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy")
private String requestUrl;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始请求时间")
@Schema(description = "开始请求时间")
private LocalDateTime[] beginTime;
@Schema(title = "执行时长", example = "100", description = "大于等于,单位:毫秒")
@Schema(description = "执行时长,大于等于,单位:毫秒", example = "100")
private Integer duration;
@Schema(title = "结果码", example = "0")
@Schema(description = "结果码", example = "0")
private Integer resultCode;
}

View File

@@ -7,16 +7,16 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - API 访问日志 Response VO")
@Schema(description = "管理后台 - API 访问日志 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ApiAccessLogRespVO extends ApiAccessLogBaseVO {
@Schema(title = "日志主键", required = true, example = "1024")
@Schema(description = "日志主键", required = true, example = "1024")
private Long id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -15,80 +15,80 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@Data
public class ApiErrorLogBaseVO {
@Schema(title = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002")
@Schema(description = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002")
@NotNull(message = "链路追踪编号不能为空")
private String traceId;
@Schema(title = "用户编号", required = true, example = "666")
@Schema(description = "用户编号", required = true, example = "666")
@NotNull(message = "用户编号不能为空")
private Integer userId;
@Schema(title = "用户类型", required = true, example = "1")
@Schema(description = "用户类型", required = true, example = "1")
@NotNull(message = "用户类型不能为空")
private Integer userType;
@Schema(title = "应用名", required = true, example = "dashboard")
@Schema(description = "应用名", required = true, example = "dashboard")
@NotNull(message = "应用名不能为空")
private String applicationName;
@Schema(title = "请求方法名", required = true, example = "GET")
@Schema(description = "请求方法名", required = true, example = "GET")
@NotNull(message = "请求方法名不能为空")
private String requestMethod;
@Schema(title = "请求地址", required = true, example = "/xx/yy")
@Schema(description = "请求地址", required = true, example = "/xx/yy")
@NotNull(message = "请求地址不能为空")
private String requestUrl;
@Schema(title = "请求参数", required = true)
@Schema(description = "请求参数", required = true)
@NotNull(message = "请求参数不能为空")
private String requestParams;
@Schema(title = "用户 IP", required = true, example = "127.0.0.1")
@Schema(description = "用户 IP", required = true, example = "127.0.0.1")
@NotNull(message = "用户 IP不能为空")
private String userIp;
@Schema(title = "浏览器 UA", required = true, example = "Mozilla/5.0")
@Schema(description = "浏览器 UA", required = true, example = "Mozilla/5.0")
@NotNull(message = "浏览器 UA不能为空")
private String userAgent;
@Schema(title = "异常发生时间", required = true)
@Schema(description = "异常发生时间", required = true)
@NotNull(message = "异常发生时间不能为空")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime exceptionTime;
@Schema(title = "异常名", required = true)
@Schema(description = "异常名", required = true)
@NotNull(message = "异常名不能为空")
private String exceptionName;
@Schema(title = "异常导致的消息", required = true)
@Schema(description = "异常导致的消息", required = true)
@NotNull(message = "异常导致的消息不能为空")
private String exceptionMessage;
@Schema(title = "异常导致的根消息", required = true)
@Schema(description = "异常导致的根消息", required = true)
@NotNull(message = "异常导致的根消息不能为空")
private String exceptionRootCauseMessage;
@Schema(title = "异常的栈轨迹", required = true)
@Schema(description = "异常的栈轨迹", required = true)
@NotNull(message = "异常的栈轨迹不能为空")
private String exceptionStackTrace;
@Schema(title = "异常发生的类全名", required = true)
@Schema(description = "异常发生的类全名", required = true)
@NotNull(message = "异常发生的类全名不能为空")
private String exceptionClassName;
@Schema(title = "异常发生的类文件", required = true)
@Schema(description = "异常发生的类文件", required = true)
@NotNull(message = "异常发生的类文件不能为空")
private String exceptionFileName;
@Schema(title = "异常发生的方法名", required = true)
@Schema(description = "异常发生的方法名", required = true)
@NotNull(message = "异常发生的方法名不能为空")
private String exceptionMethodName;
@Schema(title = "异常发生的方法所在行", required = true)
@Schema(description = "异常发生的方法所在行", required = true)
@NotNull(message = "异常发生的方法所在行不能为空")
private Integer exceptionLineNumber;
@Schema(title = "处理状态", required = true, example = "0")
@Schema(description = "处理状态", required = true, example = "0")
@NotNull(message = "处理状态不能为空")
private Integer processStatus;

View File

@@ -8,27 +8,27 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - API 错误日志 Excel 导出 Request VO", description = "参数和 ApiErrorLogPageReqVO 是一致的")
@Schema(description = "管理后台 - API 错误日志 Excel 导出 Request VO,参数和 ApiErrorLogPageReqVO 是一致的")
@Data
public class ApiErrorLogExportReqVO {
@Schema(title = "用户编号", example = "666")
@Schema(description = "用户编号", example = "666")
private Long userId;
@Schema(title = "用户类型", example = "1")
@Schema(description = "用户类型", example = "1")
private Integer userType;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "请求地址", example = "/xx/yy")
@Schema(description = "请求地址", example = "/xx/yy")
private String requestUrl;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "异常发生时间")
@Schema(description = "异常发生时间")
private LocalDateTime[] exceptionTime;
@Schema(title = "处理状态", example = "0")
@Schema(description = "处理状态", example = "0")
private Integer processStatus;
}

View File

@@ -11,29 +11,29 @@ import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - API 错误日志分页 Request VO")
@Schema(description = "管理后台 - API 错误日志分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ApiErrorLogPageReqVO extends PageParam {
@Schema(title = "用户编号", example = "666")
@Schema(description = "用户编号", example = "666")
private Long userId;
@Schema(title = "用户类型", example = "1")
@Schema(description = "用户类型", example = "1")
private Integer userType;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "请求地址", example = "/xx/yy")
@Schema(description = "请求地址", example = "/xx/yy")
private String requestUrl;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "异常发生时间")
@Schema(description = "异常发生时间")
private LocalDateTime[] exceptionTime;
@Schema(title = "处理状态", example = "0")
@Schema(description = "处理状态", example = "0")
private Integer processStatus;
}

View File

@@ -7,22 +7,22 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - API 错误日志 Response VO")
@Schema(description = "管理后台 - API 错误日志 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ApiErrorLogRespVO extends ApiErrorLogBaseVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
private Integer id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
@Schema(title = "处理时间", required = true)
@Schema(description = "处理时间", required = true)
private LocalDateTime processTime;
@Schema(title = "处理用户编号", example = "233")
@Schema(description = "处理用户编号", example = "233")
private Integer processUserId;
}

View File

@@ -8,28 +8,28 @@ import lombok.Data;
import java.time.Duration;
@Schema(title = "管理后台 - Redis Key 信息 Response VO")
@Schema(description = "管理后台 - Redis Key 信息 Response VO")
@Data
@Builder
@AllArgsConstructor
public class RedisKeyDefineRespVO {
@Schema(title = "Key 模板", required = true, example = "login_user:%s")
@Schema(description = "Key 模板", required = true, example = "login_user:%s")
private String keyTemplate;
@Schema(title = "Key 类型的枚举", required = true, example = "String")
@Schema(description = "Key 类型的枚举", required = true, example = "String")
private RedisKeyDefine.KeyTypeEnum keyType;
@Schema(title = "Value 类型", required = true, example = "java.lang.String")
@Schema(description = "Value 类型", required = true, example = "java.lang.String")
private Class<?> valueType;
@Schema(title = "超时类型", required = true, example = "1")
@Schema(description = "超时类型", required = true, example = "1")
private RedisKeyDefine.TimeoutTypeEnum timeoutType;
@Schema(title = "过期时间,单位:毫秒", required = true, example = "1024")
@Schema(description = "过期时间,单位:毫秒", required = true, example = "1024")
private Duration timeout;
@Schema(title = "备注", required = true, example = "啦啦啦啦~")
@Schema(description = "备注", required = true, example = "啦啦啦啦~")
private String memo;
}

View File

@@ -4,12 +4,12 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
@Schema(title = "管理后台 - 单个 Redis Key Value Response VO")
@Schema(description = "管理后台 - 单个 Redis Key Value Response VO")
@Data
@AllArgsConstructor
public class RedisKeyValueRespVO {
@Schema(title = "c5f6990767804a928f4bb96ca249febf", required = true, example = "String")
@Schema(description = "c5f6990767804a928f4bb96ca249febf", required = true, example = "String")
private String key;
@Schema(required = true, example = "String")

View File

@@ -8,34 +8,34 @@ import lombok.Data;
import java.util.List;
import java.util.Properties;
@Schema(title = "管理后台 - Redis 监控信息 Response VO")
@Schema(description = "管理后台 - Redis 监控信息 Response VO")
@Data
@Builder
@AllArgsConstructor
public class RedisMonitorRespVO {
@Schema(title = "Redis info 指令结果", required = true, description = "具体字段,查看 Redis 文档")
@Schema(description = "Redis info 指令结果,具体字段,查看 Redis 文档", required = true)
private Properties info;
@Schema(title = "Redis key 数量", required = true, example = "1024")
@Schema(description = "Redis key 数量", required = true, example = "1024")
private Long dbSize;
@Schema(title = "CommandStat 数组", required = true)
@Schema(description = "CommandStat 数组", required = true)
private List<CommandStat> commandStats;
@Schema(title = "Redis 命令统计结果")
@Schema(description = "Redis 命令统计结果")
@Data
@Builder
@AllArgsConstructor
public static class CommandStat {
@Schema(title = "Redis 命令", required = true, example = "get")
@Schema(description = "Redis 命令", required = true, example = "get")
private String command;
@Schema(title = "调用次数", required = true, example = "1024")
@Schema(description = "调用次数", required = true, example = "1024")
private Long calls;
@Schema(title = "消耗 CPU 秒数", required = true, example = "666")
@Schema(description = "消耗 CPU 秒数", required = true, example = "666")
private Long usec;
}

View File

@@ -10,23 +10,23 @@ import javax.validation.constraints.*;
@Data
public class TestDemoBaseVO {
@Schema(title = "名字", required = true)
@Schema(description = "名字", required = true)
@NotNull(message = "名字不能为空")
private String name;
@Schema(title = "状态", required = true)
@Schema(description = "状态", required = true)
@NotNull(message = "状态不能为空")
private Integer status;
@Schema(title = "类型", required = true)
@Schema(description = "类型", required = true)
@NotNull(message = "类型不能为空")
private Integer type;
@Schema(title = "分类", required = true)
@Schema(description = "分类", required = true)
@NotNull(message = "分类不能为空")
private Integer category;
@Schema(title = "备注")
@Schema(description = "备注")
private String remark;
}

View File

@@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
@Schema(title = "管理后台 - 字典类型创建 Request VO")
@Schema(description = "管理后台 - 字典类型创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -7,27 +7,27 @@ import org.springframework.format.annotation.DateTimeFormat;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 字典类型 Excel 导出 Request VO", description = "参数和 TestDemoPageReqVO 是一致的")
@Schema(description = "管理后台 - 字典类型 Excel 导出 Request VO,参数和 TestDemoPageReqVO 是一致的")
@Data
public class TestDemoExportReqVO {
@Schema(title = "名字")
@Schema(description = "名字")
private String name;
@Schema(title = "状态")
@Schema(description = "状态")
private Integer status;
@Schema(title = "类型")
@Schema(description = "类型")
private Integer type;
@Schema(title = "分类")
@Schema(description = "分类")
private Integer category;
@Schema(title = "备注")
@Schema(description = "备注")
private String remark;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -8,29 +8,29 @@ import org.springframework.format.annotation.DateTimeFormat;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(title = "管理后台 - 字典类型分页 Request VO")
@Schema(description = "管理后台 - 字典类型分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class TestDemoPageReqVO extends PageParam {
@Schema(title = "名字")
@Schema(description = "名字")
private String name;
@Schema(title = "状态")
@Schema(description = "状态")
private Integer status;
@Schema(title = "类型")
@Schema(description = "类型")
private Integer type;
@Schema(title = "分类")
@Schema(description = "分类")
private Integer category;
@Schema(title = "备注")
@Schema(description = "备注")
private String remark;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -4,16 +4,16 @@ import lombok.*;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 字典类型 Response VO")
@Schema(description = "管理后台 - 字典类型 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class TestDemoRespVO extends TestDemoBaseVO {
@Schema(title = "编号", required = true)
@Schema(description = "编号", required = true)
private Long id;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import javax.validation.constraints.*;
@Schema(title = "管理后台 - 字典类型更新 Request VO")
@Schema(description = "管理后台 - 字典类型更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class TestDemoUpdateReqVO extends TestDemoBaseVO {
@Schema(title = "编号", required = true)
@Schema(description = "编号", required = true)
@NotNull(message = "编号不能为空")
private Long id;

View File

@@ -1,5 +1,5 @@
## 提供给 baseVO、createVO、updateVO 生成字段
@Schema(title = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end)
#if (!${column.nullable})## 判断 @NotEmpty 和 @NotNull 注解
#if (${field.fieldType} == 'String')
@NotEmpty(message = "${column.columnComment}不能为空")

View File

@@ -15,7 +15,7 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
#end
#end
@Schema(title = "${sceneEnum.name} - ${table.classComment}创建 Request VO")
@Schema(description = "${sceneEnum.name} - ${table.classComment}创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -16,18 +16,18 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
#end
## 字段模板
#macro(columnTpl $prefix $prefixStr)
@Schema(title = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
private ${column.javaType}#if ("$!prefix" != "") ${prefix}${JavaField}#else ${column.javaField}#end;
#end
@Schema(title = "${sceneEnum.name} - ${table.classComment} Excel 导出 Request VO", description = "参数和 ${table.className}PageReqVO 是一致的")
@Schema(description = "${sceneEnum.name} - ${table.classComment} Excel 导出 Request VO参数和 ${table.className}PageReqVO 是一致的")
@Data
public class ${sceneEnum.prefixClass}${table.className}ExportReqVO {
#foreach ($column in $columns)
#if (${column.listOperation})##查询操作
#if (${column.listOperationCondition} == "BETWEEN")## 情况一Between 的时候
@Schema(title = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private ${column.javaType}[] ${column.javaField};
#else##情况二,非 Between 的时间

View File

@@ -16,11 +16,11 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
#end
## 字段模板
#macro(columnTpl $prefix $prefixStr)
@Schema(title = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
private ${column.javaType}#if ("$!prefix" != "") ${prefix}${JavaField}#else ${column.javaField}#end;
#end
@Schema(title = "${sceneEnum.name} - ${table.classComment}分页 Request VO")
@Schema(description = "${sceneEnum.name} - ${table.classComment}分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@@ -29,7 +29,7 @@ public class ${sceneEnum.prefixClass}${table.className}PageReqVO extends PagePar
#foreach ($column in $columns)
#if (${column.listOperation})##查询操作
#if (${column.listOperationCondition} == "BETWEEN")## 情况一Between 的时候
@Schema(title = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end)
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private ${column.javaType}[] ${column.javaField};
#else##情况二,非 Between 的时间

View File

@@ -9,7 +9,7 @@ import java.time.LocalDateTime;
#end
import io.swagger.annotations.*;
@Schema(title = "${sceneEnum.name} - ${table.classComment} Response VO")
@Schema(description = "${sceneEnum.name} - ${table.classComment} Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@@ -17,7 +17,7 @@ public class ${sceneEnum.prefixClass}${table.className}RespVO extends ${sceneEnu
#foreach ($column in $columns)
#if (${column.listOperationResult} && (!${column.createOperation} || !${column.updateOperation}))##不是通用字段
@Schema(title = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end)
@Schema(description = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end)
private ${column.javaType} ${column.javaField};
#end

View File

@@ -15,7 +15,7 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
#end
#end
@Schema(title = "${sceneEnum.name} - ${table.classComment}更新 Request VO")
@Schema(description = "${sceneEnum.name} - ${table.classComment}更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)