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

@@ -14,42 +14,41 @@ import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Pattern;
@Schema(title = "管理后台 - 账号密码登录 Request VO", description = "如果登录并绑定社交用户,需要传递 social 开头的参数")
@Schema(description = "管理后台 - 账号密码登录 Request VO如果登录并绑定社交用户,需要传递 social 开头的参数")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthLoginReqVO {
@Schema(title = "账号", required = true, example = "yudaoyuanma")
@Schema(description = "账号", required = true, example = "yudaoyuanma")
@NotEmpty(message = "登录账号不能为空")
@Length(min = 4, max = 16, message = "账号长度为 4-16 位")
@Pattern(regexp = "^[A-Za-z0-9]+$", message = "账号格式为数字以及字母")
private String username;
@Schema(title = "密码", required = true, example = "buzhidao")
@Schema(description = "密码", required = true, example = "buzhidao")
@NotEmpty(message = "密码不能为空")
@Length(min = 4, max = 16, message = "密码长度为 4-16 位")
private String password;
// ========== 图片验证码相关 ==========
@Schema(title = "验证码", required = true,
example = "PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg==",
description = "验证码开启时,需要传递")
@Schema(description = "验证码,验证码开启时,需要传递", required = true,
example = "PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg==")
@NotEmpty(message = "验证码不能为空", groups = CodeEnableGroup.class)
private String captchaVerification;
// ========== 绑定社交登录时,需要传递如下参数 ==========
@Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值")
@Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10")
@InEnum(SocialTypeEnum.class)
private Integer socialType;
@Schema(title = "授权码", required = true, example = "1024")
@Schema(description = "授权码", required = true, example = "1024")
private String socialCode;
@Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62")
@Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62")
private String socialState;
/**

View File

@@ -8,23 +8,23 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 登录 Response VO")
@Schema(description = "管理后台 - 登录 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthLoginRespVO {
@Schema(title = "用户编号", required = true, example = "1024")
@Schema(description = "用户编号", required = true, example = "1024")
private Long userId;
@Schema(title = "访问令牌", required = true, example = "happy")
@Schema(description = "访问令牌", required = true, example = "happy")
private String accessToken;
@Schema(title = "刷新令牌", required = true, example = "nice")
@Schema(description = "刷新令牌", required = true, example = "nice")
private String refreshToken;
@Schema(title = "过期时间", required = true)
@Schema(description = "过期时间", required = true)
private LocalDateTime expiresTime;
}

View File

@@ -8,35 +8,35 @@ import lombok.NoArgsConstructor;
import java.util.List;
@Schema(title = "管理后台 - 登录用户的菜单信息 Response VO")
@Schema(description = "管理后台 - 登录用户的菜单信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthMenuRespVO {
@Schema(title = "菜单名称", required = true, example = "芋道")
@Schema(description = "菜单名称", required = true, example = "芋道")
private Long id;
@Schema(title = "父菜单 ID", required = true, example = "1024")
@Schema(description = "父菜单 ID", required = true, example = "1024")
private Long parentId;
@Schema(title = "菜单名称", required = true, example = "芋道")
@Schema(description = "菜单名称", required = true, example = "芋道")
private String name;
@Schema(title = "路由地址", example = "post", description = "仅菜单类型为菜单或者目录时,才需要传")
@Schema(description = "路由地址,仅菜单类型为菜单或者目录时,才需要传", example = "post")
private String path;
@Schema(title = "组件路径", example = "system/post/index", description = "仅菜单类型为菜单时,才需要传")
@Schema(description = "组件路径,仅菜单类型为菜单时,才需要传", example = "system/post/index")
private String component;
@Schema(title = "菜单图标", example = "/menu/list", description = "仅菜单类型为菜单或者目录时,才需要传")
@Schema(description = "菜单图标,仅菜单类型为菜单或者目录时,才需要传", example = "/menu/list")
private String icon;
@Schema(title = "是否可见", required = true, example = "false")
@Schema(description = "是否可见", required = true, example = "false")
private Boolean visible;
@Schema(title = "是否缓存", required = true, example = "false")
@Schema(description = "是否缓存", required = true, example = "false")
private Boolean keepAlive;
/**

View File

@@ -8,36 +8,36 @@ import lombok.NoArgsConstructor;
import java.util.Set;
@Schema(title = "管理后台 - 登录用户的权限信息 Response VO", description = "额外包括用户信息和角色列表")
@Schema(description = "管理后台 - 登录用户的权限信息 Response VO,额外包括用户信息和角色列表")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthPermissionInfoRespVO {
@Schema(title = "用户信息", required = true)
@Schema(description = "用户信息", required = true)
private UserVO user;
@Schema(title = "角色标识数组", required = true)
@Schema(description = "角色标识数组", required = true)
private Set<String> roles;
@Schema(title = "操作权限数组", required = true)
@Schema(description = "操作权限数组", required = true)
private Set<String> permissions;
@Schema(title = "用户信息 VO")
@Schema(description = "用户信息 VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public static class UserVO {
@Schema(title = "用户编号", required = true, example = "1024")
@Schema(description = "用户编号", required = true, example = "1024")
private Long id;
@Schema(title = "用户昵称", required = true, example = "芋道源码")
@Schema(description = "用户昵称", required = true, example = "芋道源码")
private String nickname;
@Schema(title = "用户头像", required = true, example = "http://www.iocoder.cn/xx.jpg")
@Schema(description = "用户头像", required = true, example = "http://www.iocoder.cn/xx.jpg")
private String avatar;
}

View File

@@ -9,19 +9,19 @@ import lombok.NoArgsConstructor;
import javax.validation.constraints.NotEmpty;
@Schema(title = "管理后台 - 短信验证码的登录 Request VO")
@Schema(description = "管理后台 - 短信验证码的登录 Request VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthSmsLoginReqVO {
@Schema(title = "手机号", required = true, example = "yudaoyuanma")
@Schema(description = "手机号", required = true, example = "yudaoyuanma")
@NotEmpty(message = "手机号不能为空")
@Mobile
private String mobile;
@Schema(title = "短信验证码", required = true, example = "1024")
@Schema(description = "短信验证码", required = true, example = "1024")
@NotEmpty(message = "验证码不能为空")
private String code;

View File

@@ -12,19 +12,19 @@ import lombok.NoArgsConstructor;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 发送手机验证码 Request VO")
@Schema(description = "管理后台 - 发送手机验证码 Request VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthSmsSendReqVO {
@Schema(title = "手机号", required = true, example = "yudaoyuanma")
@Schema(description = "手机号", required = true, example = "yudaoyuanma")
@NotEmpty(message = "手机号不能为空")
@Mobile
private String mobile;
@Schema(title = "短信场景", required = true, example = "1")
@Schema(description = "短信场景", required = true, example = "1")
@NotNull(message = "发送场景不能为空")
@InEnum(SmsSceneEnum.class)
private Integer scene;

View File

@@ -11,23 +11,23 @@ import lombok.NoArgsConstructor;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 社交绑定登录 Request VO使用 code 授权码 + 账号密码")
@Schema(description = "管理后台 - 社交绑定登录 Request VO使用 code 授权码 + 账号密码")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthSocialLoginReqVO {
@Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 UserSocialTypeEnum 枚举值")
@Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10")
@InEnum(SocialTypeEnum.class)
@NotNull(message = "社交平台的类型不能为空")
private Integer type;
@Schema(title = "授权码", required = true, example = "1024")
@Schema(description = "授权码", required = true, example = "1024")
@NotEmpty(message = "授权码不能为空")
private String code;
@Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62")
@Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62")
@NotEmpty(message = "state 不能为空")
private String state;

View File

@@ -14,31 +14,31 @@ import javax.validation.constraints.Size;
@Data
public class DeptBaseVO {
@Schema(title = "菜单名称", required = true, example = "芋道")
@Schema(description = "菜单名称", required = true, example = "芋道")
@NotBlank(message = "部门名称不能为空")
@Size(max = 30, message = "部门名称长度不能超过30个字符")
private String name;
@Schema(title = "父菜单 ID", example = "1024")
@Schema(description = "父菜单 ID", example = "1024")
private Long parentId;
@Schema(title = "显示顺序不能为空", required = true, example = "1024")
@Schema(description = "显示顺序不能为空", required = true, example = "1024")
@NotNull(message = "显示顺序不能为空")
private Integer sort;
@Schema(title = "负责人的用户编号", example = "2048")
@Schema(description = "负责人的用户编号", example = "2048")
private Long leaderUserId;
@Schema(title = "联系电话", example = "15601691000")
@Schema(description = "联系电话", example = "15601691000")
@Size(max = 11, message = "联系电话长度不能超过11个字符")
private String phone;
@Schema(title = "邮箱", example = "yudao@iocoder.cn")
@Schema(description = "邮箱", example = "yudao@iocoder.cn")
@Email(message = "邮箱格式不正确")
@Size(max = 50, message = "邮箱长度不能超过50个字符")
private String email;
@Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
// @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}")
private Integer status;

View File

@@ -4,7 +4,7 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 部门创建 Request VO")
@Schema(description = "管理后台 - 部门创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.system.controller.admin.dept.vo.dept;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 部门列表 Request VO")
@Schema(description = "管理后台 - 部门列表 Request VO")
@Data
public class DeptListReqVO {
@Schema(title = "部门名称", example = "芋道", description = "模糊匹配")
@Schema(description = "部门名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -6,18 +6,18 @@ import lombok.EqualsAndHashCode;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 部门信息 Response VO")
@Schema(description = "管理后台 - 部门信息 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DeptRespVO extends DeptBaseVO {
@Schema(title = "部门编号", required = true, example = "1024")
@Schema(description = "部门编号", required = true, example = "1024")
private Long id;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -5,19 +5,19 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Schema(title = "管理后台 - 部门精简信息 Response VO")
@Schema(description = "管理后台 - 部门精简信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class DeptSimpleRespVO {
@Schema(title = "部门编号", required = true, example = "1024")
@Schema(description = "部门编号", required = true, example = "1024")
private Long id;
@Schema(title = "部门名称", required = true, example = "芋道")
@Schema(description = "部门名称", required = true, example = "芋道")
private String name;
@Schema(title = "父部门 ID", required = true, example = "1024")
@Schema(description = "父部门 ID", required = true, example = "1024")
private Long parentId;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 部门更新 Request VO")
@Schema(description = "管理后台 - 部门更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DeptUpdateReqVO extends DeptBaseVO {
@Schema(title = "部门编号", required = true, example = "1024")
@Schema(description = "部门编号", required = true, example = "1024")
@NotNull(message = "部门编号不能为空")
private Long id;

View File

@@ -13,24 +13,24 @@ import javax.validation.constraints.Size;
@Data
public class PostBaseVO {
@Schema(title = "岗位名称", required = true, example = "小博主")
@Schema(description = "岗位名称", required = true, example = "小博主")
@NotBlank(message = "岗位名称不能为空")
@Size(max = 50, message = "岗位名称长度不能超过50个字符")
private String name;
@Schema(title = "岗位编码", required = true, example = "yudao")
@Schema(description = "岗位编码", required = true, example = "yudao")
@NotBlank(message = "岗位编码不能为空")
@Size(max = 64, message = "岗位编码长度不能超过64个字符")
private String code;
@Schema(title = "显示顺序不能为空", required = true, example = "1024")
@Schema(description = "显示顺序不能为空", required = true, example = "1024")
@NotNull(message = "显示顺序不能为空")
private Integer sort;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(title = "备注", example = "快乐的备注")
@Schema(description = "备注", example = "快乐的备注")
private String remark;
}

View File

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 岗位创建 Request VO")
@Schema(description = "管理后台 - 岗位创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class PostCreateReqVO extends PostBaseVO {

View File

@@ -3,17 +3,17 @@ package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 岗位导出 Request VO", description = "参数和 PostExcelVO 是一致的")
@Schema(description = "管理后台 - 岗位导出 Request VO,参数和 PostExcelVO 是一致的")
@Data
public class PostExportReqVO {
@Schema(title = "岗位编码", example = "yudao", description = "模糊匹配")
@Schema(description = "岗位编码,模糊匹配", example = "yudao")
private String code;
@Schema(title = "岗位名称", example = "芋道", description = "模糊匹配")
@Schema(description = "岗位名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -4,15 +4,15 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 岗位列表 Request VO")
@Schema(description = "管理后台 - 岗位列表 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class PostListReqVO extends PostBaseVO {
@Schema(title = "岗位名称", example = "芋道", description = "模糊匹配")
@Schema(description = "岗位名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -5,18 +5,18 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 岗位分页 Request VO")
@Schema(description = "管理后台 - 岗位分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class PostPageReqVO extends PageParam {
@Schema(title = "岗位编码", example = "yudao", description = "模糊匹配")
@Schema(description = "岗位编码,模糊匹配", example = "yudao")
private String code;
@Schema(title = "岗位名称", example = "芋道", description = "模糊匹配")
@Schema(description = "岗位名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -6,15 +6,15 @@ import lombok.EqualsAndHashCode;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 岗位信息 Response VO")
@Schema(description = "管理后台 - 岗位信息 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class PostRespVO extends PostBaseVO {
@Schema(title = "岗位序号", required = true, example = "1024")
@Schema(description = "岗位序号", required = true, example = "1024")
private Long id;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -5,16 +5,16 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Schema(title = "管理后台 - 岗位精简信息 Response VO")
@Schema(description = "管理后台 - 岗位精简信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class PostSimpleRespVO {
@Schema(title = "岗位编号", required = true, example = "1024")
@Schema(description = "岗位编号", required = true, example = "1024")
private Long id;
@Schema(title = "岗位名称", required = true, example = "芋道")
@Schema(description = "岗位名称", required = true, example = "芋道")
private String name;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 岗位更新 Request VO")
@Schema(description = "管理后台 - 岗位更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class PostUpdateReqVO extends PostBaseVO {
@Schema(title = "岗位编号", required = true, example = "1024")
@Schema(description = "岗位编号", required = true, example = "1024")
@NotNull(message = "岗位编号不能为空")
private Long id;

View File

@@ -14,36 +14,36 @@ import javax.validation.constraints.Size;
@Data
public class DictDataBaseVO {
@Schema(title = "显示顺序不能为空", required = true, example = "1024")
@Schema(description = "显示顺序不能为空", required = true, example = "1024")
@NotNull(message = "显示顺序不能为空")
private Integer sort;
@Schema(title = "字典标签", required = true, example = "芋道")
@Schema(description = "字典标签", required = true, example = "芋道")
@NotBlank(message = "字典标签不能为空")
@Size(max = 100, message = "字典标签长度不能超过100个字符")
private String label;
@Schema(title = "字典值", required = true, example = "iocoder")
@Schema(description = "字典值", required = true, example = "iocoder")
@NotBlank(message = "字典键值不能为空")
@Size(max = 100, message = "字典键值长度不能超过100个字符")
private String value;
@Schema(title = "字典类型", required = true, example = "sys_common_sex")
@Schema(description = "字典类型", required = true, example = "sys_common_sex")
@NotBlank(message = "字典类型不能为空")
@Size(max = 100, message = "字典类型长度不能超过100个字符")
private String dictType;
@Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
// @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}")
private Integer status;
@Schema(title = "颜色类型", example = "default", description = "default、primary、success、info、warning、danger")
@Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default")
private String colorType;
@Schema(title = "css 样式", example = "btn-visible")
@Schema(description = "css 样式", example = "btn-visible")
private String cssClass;
@Schema(title = "备注", example = "我是一个角色")
@Schema(description = "备注", example = "我是一个角色")
private String remark;
}

View File

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 字典数据创建 Request VO")
@Schema(description = "管理后台 - 字典数据创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DictDataCreateReqVO extends DictDataBaseVO {

View File

@@ -5,19 +5,19 @@ import lombok.Data;
import javax.validation.constraints.Size;
@Schema(title = "管理后台 - 字典类型导出 Request VO")
@Schema(description = "管理后台 - 字典类型导出 Request VO")
@Data
public class DictDataExportReqVO {
@Schema(title = "字典标签", example = "芋道")
@Schema(description = "字典标签", example = "芋道")
@Size(max = 100, message = "字典标签长度不能超过100个字符")
private String label;
@Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配")
@Schema(description = "字典类型,模糊匹配", example = "sys_common_sex")
@Size(max = 100, message = "字典类型类型长度不能超过100个字符")
private String dictType;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -7,20 +7,20 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.Size;
@Schema(title = "管理后台 - 字典类型分页列表 Request VO")
@Schema(description = "管理后台 - 字典类型分页列表 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DictDataPageReqVO extends PageParam {
@Schema(title = "字典标签", example = "芋道")
@Schema(description = "字典标签", example = "芋道")
@Size(max = 100, message = "字典标签长度不能超过100个字符")
private String label;
@Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配")
@Schema(description = "字典类型,模糊匹配", example = "sys_common_sex")
@Size(max = 100, message = "字典类型类型长度不能超过100个字符")
private String dictType;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -8,17 +8,17 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 字典数据信息 Response VO")
@Schema(description = "管理后台 - 字典数据信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class DictDataRespVO extends DictDataBaseVO {
@Schema(title = "字典数据编号", required = true, example = "1024")
@Schema(description = "字典数据编号", required = true, example = "1024")
private Long id;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -3,22 +3,22 @@ package cn.iocoder.yudao.module.system.controller.admin.dict.vo.data;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 数据字典精简 Response VO")
@Schema(description = "管理后台 - 数据字典精简 Response VO")
@Data
public class DictDataSimpleRespVO {
@Schema(title = "字典类型", required = true, example = "gender")
@Schema(description = "字典类型", required = true, example = "gender")
private String dictType;
@Schema(title = "字典键值", required = true, example = "1")
@Schema(description = "字典键值", required = true, example = "1")
private String value;
@Schema(title = "字典标签", required = true, example = "")
@Schema(description = "字典标签", required = true, example = "")
private String label;
@Schema(title = "颜色类型", example = "default", description = "default、primary、success、info、warning、danger")
@Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default")
private String colorType;
@Schema(title = "css 样式", example = "btn-visible")
@Schema(description = "css 样式", example = "btn-visible")
private String cssClass;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 字典数据更新 Request VO")
@Schema(description = "管理后台 - 字典数据更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DictDataUpdateReqVO extends DictDataBaseVO {
@Schema(title = "字典数据编号", required = true, example = "1024")
@Schema(description = "字典数据编号", required = true, example = "1024")
@NotNull(message = "字典数据编号不能为空")
private Long id;

View File

@@ -14,16 +14,16 @@ import javax.validation.constraints.Size;
@Data
public class DictTypeBaseVO {
@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 = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;
@Schema(title = "备注", example = "快乐的备注")
@Schema(description = "备注", example = "快乐的备注")
private String remark;
}

View File

@@ -7,12 +7,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
@Schema(title = "管理后台 - 字典类型创建 Request VO")
@Schema(description = "管理后台 - 字典类型创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DictTypeCreateReqVO extends DictTypeBaseVO {
@Schema(title = "字典类型", required = true, example = "sys_common_sex")
@Schema(description = "字典类型", required = true, example = "sys_common_sex")
@NotNull(message = "字典类型不能为空")
@Size(max = 100, message = "字典类型类型长度不能超过100个字符")
private String type;

View File

@@ -8,21 +8,21 @@ 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 DictTypeExportReqVO {
@Schema(title = "字典类型名称", example = "芋道", description = "模糊匹配")
@Schema(description = "字典类型名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配")
@Schema(description = "字典类型,模糊匹配", example = "sys_common_sex")
private String type;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -11,23 +11,23 @@ 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)
public class DictTypePageReqVO extends PageParam {
@Schema(title = "字典类型名称", example = "芋道", description = "模糊匹配")
@Schema(description = "字典类型名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配")
@Schema(description = "字典类型,模糊匹配", example = "sys_common_sex")
@Size(max = 100, message = "字典类型类型长度不能超过100个字符")
private String type;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -8,20 +8,20 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 字典类型信息 Response VO")
@Schema(description = "管理后台 - 字典类型信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class DictTypeRespVO extends DictTypeBaseVO {
@Schema(title = "字典类型编号", required = true, example = "1024")
@Schema(description = "字典类型编号", required = true, example = "1024")
private Long id;
@Schema(title = "字典类型", required = true, example = "sys_common_sex")
@Schema(description = "字典类型", required = true, example = "sys_common_sex")
private String type;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -5,19 +5,19 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Schema(title = "管理后台 - 字典类型精简信息 Response VO")
@Schema(description = "管理后台 - 字典类型精简信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class DictTypeSimpleRespVO {
@Schema(title = "字典类型编号", required = true, example = "1024")
@Schema(description = "字典类型编号", required = true, example = "1024")
private Long id;
@Schema(title = "字典类型名称", required = true, example = "芋道")
@Schema(description = "字典类型名称", required = true, example = "芋道")
private String name;
@Schema(title = "字典类型", required = true, example = "sys_common_sex")
@Schema(description = "字典类型", required = true, example = "sys_common_sex")
private String type;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 字典类型更新 Request VO")
@Schema(description = "管理后台 - 字典类型更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class DictTypeUpdateReqVO extends DictTypeBaseVO {
@Schema(title = "字典类型编号", required = true, example = "1024")
@Schema(description = "字典类型编号", required = true, example = "1024")
@NotNull(message = "字典类型编号不能为空")
private Long id;

View File

@@ -12,19 +12,19 @@ import javax.validation.constraints.NotNull;
@Data
public class ErrorCodeBaseVO {
@Schema(title = "应用名", required = true, example = "dashboard")
@Schema(description = "应用名", required = true, example = "dashboard")
@NotNull(message = "应用名不能为空")
private String applicationName;
@Schema(title = "错误码编码", required = true, example = "1234")
@Schema(description = "错误码编码", required = true, example = "1234")
@NotNull(message = "错误码编码不能为空")
private Integer code;
@Schema(title = "错误码错误提示", required = true, example = "帅气")
@Schema(description = "错误码错误提示", required = true, example = "帅气")
@NotNull(message = "错误码错误提示不能为空")
private String message;
@Schema(title = "备注", example = "哈哈哈")
@Schema(description = "备注", example = "哈哈哈")
private String memo;
}

View File

@@ -5,7 +5,7 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 错误码创建 Request VO")
@Schema(description = "管理后台 - 错误码创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -8,24 +8,24 @@ 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 = "参数和 InfErrorCodePageReqVO 是一致的")
@Schema(description = "管理后台 - 错误码 Excel 导出 Request VO,参数和 InfErrorCodePageReqVO 是一致的")
@Data
public class ErrorCodeExportReqVO {
@Schema(title = "错误码类型", example = "1")
@Schema(description = "错误码类型", example = "1")
private Integer type;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "错误码编码", example = "1234")
@Schema(description = "错误码编码", example = "1234")
private Integer code;
@Schema(title = "错误码错误提示", example = "帅气")
@Schema(description = "错误码错误提示", example = "帅气")
private String message;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -11,26 +11,26 @@ 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 ErrorCodePageReqVO extends PageParam {
@Schema(title = "错误码类型", example = "1", description = "参见 ErrorCodeTypeEnum 枚举类")
@Schema(description = "错误码类型,参见 ErrorCodeTypeEnum 枚举类", example = "1")
private Integer type;
@Schema(title = "应用名", example = "dashboard")
@Schema(description = "应用名", example = "dashboard")
private String applicationName;
@Schema(title = "错误码编码", example = "1234")
@Schema(description = "错误码编码", example = "1234")
private Integer code;
@Schema(title = "错误码错误提示", example = "帅气")
@Schema(description = "错误码错误提示", example = "帅气")
private String message;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -7,19 +7,19 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 错误码 Response VO")
@Schema(description = "管理后台 - 错误码 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class ErrorCodeRespVO extends ErrorCodeBaseVO {
@Schema(title = "错误码编号", required = true, example = "1024")
@Schema(description = "错误码编号", required = true, example = "1024")
private Long id;
@Schema(title = "错误码类型", required = true, example = "1", description = "参见 ErrorCodeTypeEnum 枚举类")
@Schema(description = "错误码类型,参见 ErrorCodeTypeEnum 枚举类", required = true, example = "1")
private Integer type;
@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 ErrorCodeUpdateReqVO extends ErrorCodeBaseVO {
@Schema(title = "错误码编号", required = true, example = "1024")
@Schema(description = "错误码编号", required = true, example = "1024")
@NotNull(message = "错误码编号不能为空")
private Long id;

View File

@@ -15,28 +15,28 @@ import javax.validation.constraints.Size;
@Data
public class LoginLogBaseVO {
@Schema(title = "日志类型", required = true, example = "1", description = "参见 LoginLogTypeEnum 枚举类")
@Schema(description = "日志类型,参见 LoginLogTypeEnum 枚举类", required = true, example = "1")
@NotNull(message = "日志类型不能为空")
private Integer logType;
@Schema(title = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab")
@Schema(description = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab")
@NotEmpty(message = "链路追踪编号不能为空")
private String traceId;
@Schema(title = "用户账号", required = true, example = "yudao")
@Schema(description = "用户账号", required = true, example = "yudao")
@NotBlank(message = "用户账号不能为空")
@Size(max = 30, message = "用户账号长度不能超过30个字符")
private String username;
@Schema(title = "登录结果", required = true, example = "1", description = "参见 LoginResultEnum 枚举类")
@Schema(description = "登录结果,参见 LoginResultEnum 枚举类", required = true, example = "1")
@NotNull(message = "登录结果不能为空")
private Integer result;
@Schema(title = "用户 IP", required = true, example = "127.0.0.1")
@Schema(description = "用户 IP", required = true, example = "127.0.0.1")
@NotEmpty(message = "用户 IP 不能为空")
private String userIp;
@Schema(title = "浏览器 UserAgent", example = "Mozilla/5.0")
@Schema(description = "浏览器 UserAgent", example = "Mozilla/5.0")
private String userAgent;
}

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 LoginLogExportReqVO {
@Schema(title = "用户 IP", example = "127.0.0.1", description = "模拟匹配")
@Schema(description = "用户 IP,模拟匹配", example = "127.0.0.1")
private String userIp;
@Schema(title = "用户账号", example = "芋道", description = "模拟匹配")
@Schema(description = "用户账号,模拟匹配", example = "芋道")
private String username;
@Schema(title = "操作状态", example = "true")
@Schema(description = "操作状态", example = "true")
private Boolean status;
@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

@@ -10,21 +10,21 @@ 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)
public class LoginLogPageReqVO extends PageParam {
@Schema(title = "用户 IP", example = "127.0.0.1", description = "模拟匹配")
@Schema(description = "用户 IP,模拟匹配", example = "127.0.0.1")
private String userIp;
@Schema(title = "用户账号", example = "芋道", description = "模拟匹配")
@Schema(description = "用户账号,模拟匹配", example = "芋道")
private String username;
@Schema(title = "操作状态", example = "true")
@Schema(description = "操作状态", example = "true")
private Boolean status;
@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 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 LoginLogRespVO extends LoginLogBaseVO {
@Schema(title = "日志编号", required = true, example = "1024")
@Schema(description = "日志编号", required = true, example = "1024")
private Long id;
@Schema(title = "用户编号", example = "666")
@Schema(description = "用户编号", example = "666")
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)
@Schema(description = "登录时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -15,71 +15,71 @@ import java.util.Map;
@Data
public class OperateLogBaseVO {
@Schema(title = "链路追踪编号", required = true, example = "89aca178-a370-411c-ae02-3f0d672be4ab")
@Schema(description = "链路追踪编号", required = true, example = "89aca178-a370-411c-ae02-3f0d672be4ab")
@NotEmpty(message = "链路追踪编号不能为空")
private String traceId;
@Schema(title = "用户编号", required = true, example = "1024")
@Schema(description = "用户编号", required = true, example = "1024")
@NotNull(message = "用户编号不能为空")
private Long userId;
@Schema(title = "操作模块", required = true, example = "订单")
@Schema(description = "操作模块", required = true, example = "订单")
@NotEmpty(message = "操作模块不能为空")
private String module;
@Schema(title = "操作名", required = true, example = "创建订单")
@Schema(description = "操作名", required = true, example = "创建订单")
@NotEmpty(message = "操作名")
private String name;
@Schema(title = "操作分类", required = true, example = "1", description = "参见 OperateLogTypeEnum 枚举类")
@Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", required = true, example = "1")
@NotNull(message = "操作分类不能为空")
private Integer type;
@Schema(title = "操作明细", example = "修改编号为 1 的用户信息,将性别从男改成女,将姓名从芋道改成源码。")
@Schema(description = "操作明细", example = "修改编号为 1 的用户信息,将性别从男改成女,将姓名从芋道改成源码。")
private String content;
@Schema(title = "拓展字段", example = "{'orderId': 1}")
@Schema(description = "拓展字段", example = "{'orderId': 1}")
private Map<String, Object> exts;
@Schema(title = "请求方法名", required = true, example = "GET")
@Schema(description = "请求方法名", required = true, example = "GET")
@NotEmpty(message = "请求方法名不能为空")
private String requestMethod;
@Schema(title = "请求地址", required = true, example = "/xxx/yyy")
@Schema(description = "请求地址", required = true, example = "/xxx/yyy")
@NotEmpty(message = "请求地址不能为空")
private String requestUrl;
@Schema(title = "用户 IP", required = true, example = "127.0.0.1")
@Schema(description = "用户 IP", required = true, example = "127.0.0.1")
@NotEmpty(message = "用户 IP 不能为空")
private String userIp;
@Schema(title = "浏览器 UserAgent", required = true, example = "Mozilla/5.0")
@Schema(description = "浏览器 UserAgent", required = true, example = "Mozilla/5.0")
@NotEmpty(message = "浏览器 UserAgent 不能为空")
private String userAgent;
@Schema(title = "Java 方法名", required = true, example = "cn.iocoder.yudao.adminserver.UserController.save(...)")
@Schema(description = "Java 方法名", required = true, example = "cn.iocoder.yudao.adminserver.UserController.save(...)")
@NotEmpty(message = "Java 方法名不能为空")
private String javaMethod;
@Schema(title = "Java 方法的参数")
@Schema(description = "Java 方法的参数")
private String javaMethodArgs;
@Schema(title = "开始时间", required = true)
@Schema(description = "开始时间", required = true)
@NotNull(message = "开始时间不能为空")
private LocalDateTime startTime;
@Schema(title = "执行时长,单位:毫秒", required = true)
@Schema(description = "执行时长,单位:毫秒", required = true)
@NotNull(message = "执行时长不能为空")
private Integer duration;
@Schema(title = "结果码", required = true)
@Schema(description = "结果码", required = true)
@NotNull(message = "结果码不能为空")
private Integer resultCode;
@Schema(title = "结果提示")
@Schema(description = "结果提示")
private String resultMsg;
@Schema(title = "结果数据")
@Schema(description = "结果数据")
private String resultData;
}

View File

@@ -8,23 +8,23 @@ 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 OperateLogExportReqVO {
@Schema(title = "操作模块", example = "订单", description = "模拟匹配")
@Schema(description = "操作模块,模拟匹配", example = "订单")
private String module;
@Schema(title = "用户昵称", example = "芋道", description = "模拟匹配")
@Schema(description = "用户昵称,模拟匹配", example = "芋道")
private String userNickname;
@Schema(title = "操作分类", example = "1", description = "参见 OperateLogTypeEnum 枚举类")
@Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", example = "1")
private Integer type;
@Schema(title = "操作状态", example = "true")
@Schema(description = "操作状态", example = "true")
private Boolean success;
@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[] startTime;

View File

@@ -9,23 +9,23 @@ 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 OperateLogPageReqVO extends PageParam {
@Schema(title = "操作模块", example = "订单", description = "模拟匹配")
@Schema(description = "操作模块,模拟匹配", example = "订单")
private String module;
@Schema(title = "用户昵称", example = "芋道", description = "模拟匹配")
@Schema(description = "用户昵称,模拟匹配", example = "芋道")
private String userNickname;
@Schema(title = "操作分类", example = "1", description = "参见 OperateLogTypeEnum 枚举类")
@Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", example = "1")
private Integer type;
@Schema(title = "操作状态", example = "true")
@Schema(description = "操作状态", example = "true")
private Boolean success;
@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[] startTime;

View File

@@ -5,16 +5,16 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 操作日志 Response VO")
@Schema(description = "管理后台 - 操作日志 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class OperateLogRespVO extends OperateLogBaseVO {
@Schema(title = "日志编号", required = true, example = "1024")
@Schema(description = "日志编号", required = true, example = "1024")
private Long id;
@Schema(title = "用户昵称", required = true, example = "芋艿")
@Schema(description = "用户昵称", required = true, example = "芋艿")
private String userNickname;
}

View File

@@ -14,19 +14,19 @@ import javax.validation.constraints.Size;
@Data
public class NoticeBaseVO {
@Schema(title = "公告标题", required = true, example = "小博主")
@Schema(description = "公告标题", required = true, example = "小博主")
@NotBlank(message = "公告标题不能为空")
@Size(max = 50, message = "公告标题不能超过50个字符")
private String title;
@Schema(title = "公告类型", required = true, example = "小博主")
@Schema(description = "公告类型", required = true, example = "小博主")
@NotNull(message = "公告类型不能为空")
private Integer type;
@Schema(title = "公告内容", required = true, example = "半生编码")
@Schema(description = "公告内容", required = true, example = "半生编码")
private String content;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
}

View File

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 通知公告创建 Request VO")
@Schema(description = "管理后台 - 通知公告创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class NoticeCreateReqVO extends NoticeBaseVO {

View File

@@ -5,15 +5,15 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 通知公告分页 Request VO")
@Schema(description = "管理后台 - 通知公告分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class NoticePageReqVO extends PageParam {
@Schema(title = "通知公告名称", example = "芋道", description = "模糊匹配")
@Schema(description = "通知公告名称,模糊匹配", example = "芋道")
private String title;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -6,15 +6,15 @@ import lombok.EqualsAndHashCode;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 通知公告信息 Response VO")
@Schema(description = "管理后台 - 通知公告信息 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class NoticeRespVO extends NoticeBaseVO {
@Schema(title = "通知公告序号", required = true, example = "1024")
@Schema(description = "通知公告序号", required = true, example = "1024")
private Long id;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 岗位公告更新 Request VO")
@Schema(description = "管理后台 - 岗位公告更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class NoticeUpdateReqVO extends NoticeBaseVO {
@Schema(title = "岗位公告编号", required = true, example = "1024")
@Schema(description = "岗位公告编号", required = true, example = "1024")
@NotNull(message = "岗位公告编号不能为空")
private Long id;

View File

@@ -18,60 +18,60 @@ import java.util.List;
@Data
public class OAuth2ClientBaseVO {
@Schema(title = "客户端编号", required = true, example = "tudou")
@Schema(description = "客户端编号", required = true, example = "tudou")
@NotNull(message = "客户端编号不能为空")
private String clientId;
@Schema(title = "客户端密钥", required = true, example = "fan")
@Schema(description = "客户端密钥", required = true, example = "fan")
@NotNull(message = "客户端密钥不能为空")
private String secret;
@Schema(title = "应用名", required = true, example = "土豆")
@Schema(description = "应用名", required = true, example = "土豆")
@NotNull(message = "应用名不能为空")
private String name;
@Schema(title = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png")
@Schema(description = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png")
@NotNull(message = "应用图标不能为空")
@URL(message = "应用图标的地址不正确")
private String logo;
@Schema(title = "应用描述", example = "我是一个应用")
@Schema(description = "应用描述", example = "我是一个应用")
private String description;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;
@Schema(title = "访问令牌的有效期", required = true, example = "8640")
@Schema(description = "访问令牌的有效期", required = true, example = "8640")
@NotNull(message = "访问令牌的有效期不能为空")
private Integer accessTokenValiditySeconds;
@Schema(title = "刷新令牌的有效期", required = true, example = "8640000")
@Schema(description = "刷新令牌的有效期", required = true, example = "8640000")
@NotNull(message = "刷新令牌的有效期不能为空")
private Integer refreshTokenValiditySeconds;
@Schema(title = "可重定向的 URI 地址", required = true, example = "https://www.iocoder.cn")
@Schema(description = "可重定向的 URI 地址", required = true, example = "https://www.iocoder.cn")
@NotNull(message = "可重定向的 URI 地址不能为空")
private List<@NotEmpty(message = "重定向的 URI 不能为空")
@URL(message = "重定向的 URI 格式不正确") String> redirectUris;
@Schema(title = "授权类型", required = true, example = "password", description = "参见 OAuth2GrantTypeEnum 枚举")
@Schema(description = "授权类型,参见 OAuth2GrantTypeEnum 枚举", required = true, example = "password")
@NotNull(message = "授权类型不能为空")
private List<String> authorizedGrantTypes;
@Schema(title = "授权范围", example = "user_info")
@Schema(description = "授权范围", example = "user_info")
private List<String> scopes;
@Schema(title = "自动通过的授权范围", example = "user_info")
@Schema(description = "自动通过的授权范围", example = "user_info")
private List<String> autoApproveScopes;
@Schema(title = "权限", example = "system:user:query")
@Schema(description = "权限", example = "system:user:query")
private List<String> authorities;
@Schema(title = "资源", example = "1024")
@Schema(description = "资源", example = "1024")
private List<String> resourceIds;
@Schema(title = "附加信息", example = "{yunai: true}")
@Schema(description = "附加信息", example = "{yunai: true}")
private String additionalInformation;
@AssertTrue(message = "附加信息必须是 JSON 格式")

View File

@@ -3,7 +3,7 @@ package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
@Schema(title = "管理后台 - OAuth2 客户端创建 Request VO")
@Schema(description = "管理后台 - OAuth2 客户端创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -4,16 +4,16 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
@Schema(title = "管理后台 - OAuth2 客户端分页 Request VO")
@Schema(description = "管理后台 - OAuth2 客户端分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class OAuth2ClientPageReqVO extends PageParam {
@Schema(title = "应用名", example = "土豆", description = "模糊匹配")
@Schema(description = "应用名,模糊匹配", example = "土豆")
private String name;
@Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1")
private Integer status;
}

View File

@@ -7,16 +7,16 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - OAuth2 客户端 Response VO")
@Schema(description = "管理后台 - OAuth2 客户端 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class OAuth2ClientRespVO extends OAuth2ClientBaseVO {
@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

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

View File

@@ -6,29 +6,29 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Schema(title = "管理后台 - 【开放接口】访问令牌 Response VO")
@Schema(description = "管理后台 - 【开放接口】访问令牌 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2OpenAccessTokenRespVO {
@Schema(title = "访问令牌", required = true, example = "tudou")
@Schema(description = "访问令牌", required = true, example = "tudou")
@JsonProperty("access_token")
private String accessToken;
@Schema(title = "刷新令牌", required = true, example = "nice")
@Schema(description = "刷新令牌", required = true, example = "nice")
@JsonProperty("refresh_token")
private String refreshToken;
@Schema(title = "令牌类型", required = true, example = "bearer")
@Schema(description = "令牌类型", required = true, example = "bearer")
@JsonProperty("token_type")
private String tokenType;
@Schema(title = "过期时间", required = true, example = "42430", description = "单位:秒")
@Schema(description = "过期时间,单位:秒", required = true, example = "42430")
@JsonProperty("expires_in")
private Long expiresIn;
@Schema(title = "授权范围", example = "user_info", description = "如果多个授权范围,使用空格分隔")
@Schema(description = "授权范围,如果多个授权范围,使用空格分隔", example = "user_info")
private String scope;
}

View File

@@ -8,7 +8,7 @@ import lombok.NoArgsConstructor;
import java.util.List;
@Schema(title = "管理后台 - 授权页的信息 Response VO")
@Schema(description = "管理后台 - 授权页的信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@@ -19,7 +19,7 @@ public class OAuth2OpenAuthorizeInfoRespVO {
*/
private Client client;
@Schema(title = "scope 的选中信息", required = true, description = "使用 List 保证有序性Key 是 scopeValue 为是否选中")
@Schema(description = "scope 的选中信息,使用 List 保证有序性Key 是 scopeValue 为是否选中", required = true)
private List<KeyValue<String, Boolean>> scopes;
@Data
@@ -27,10 +27,10 @@ public class OAuth2OpenAuthorizeInfoRespVO {
@AllArgsConstructor
public static class Client {
@Schema(title = "应用名", required = true, example = "土豆")
@Schema(description = "应用名", required = true, example = "土豆")
private String name;
@Schema(title = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png")
@Schema(description = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png")
private String logo;
}

View File

@@ -8,33 +8,33 @@ import lombok.NoArgsConstructor;
import java.util.List;
@Schema(title = "管理后台 - 【开放接口】校验令牌 Response VO")
@Schema(description = "管理后台 - 【开放接口】校验令牌 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2OpenCheckTokenRespVO {
@Schema(title = "用户编号", required = true, example = "666")
@Schema(description = "用户编号", required = true, example = "666")
@JsonProperty("user_id")
private Long userId;
@Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
@JsonProperty("user_type")
private Integer userType;
@Schema(title = "租户编号", required = true, example = "1024")
@Schema(description = "租户编号", required = true, example = "1024")
@JsonProperty("tenant_id")
private Long tenantId;
@Schema(title = "客户端编号", required = true, example = "car")
@Schema(description = "客户端编号", required = true, example = "car")
@JsonProperty("client_id")
private String clientId;
@Schema(title = "授权范围", required = true, example = "user_info")
@Schema(description = "授权范围", required = true, example = "user_info")
private List<String> scopes;
@Schema(title = "访问令牌", required = true, example = "tudou")
@Schema(description = "访问令牌", required = true, example = "tudou")
@JsonProperty("access_token")
private String accessToken;
@Schema(title = "过期时间", required = true, example = "1593092157", description = "时间戳 / 1000即单位")
@Schema(description = "过期时间,时间戳 / 1000即单位", required = true, example = "1593092157")
private Long exp;
}

View File

@@ -5,18 +5,18 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 访问令牌分页 Request VO")
@Schema(description = "管理后台 - 访问令牌分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class OAuth2AccessTokenPageReqVO extends PageParam {
@Schema(title = "用户编号", required = true, example = "666")
@Schema(description = "用户编号", required = true, example = "666")
private Long userId;
@Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
private Integer userType;
@Schema(title = "客户端编号", required = true, example = "2")
@Schema(description = "客户端编号", required = true, example = "2")
private String clientId;
}

View File

@@ -7,34 +7,34 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 访问令牌 Response VO")
@Schema(description = "管理后台 - 访问令牌 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2AccessTokenRespVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
private Long id;
@Schema(title = "访问令牌", required = true, example = "tudou")
@Schema(description = "访问令牌", required = true, example = "tudou")
private String accessToken;
@Schema(title = "刷新令牌", required = true, example = "nice")
@Schema(description = "刷新令牌", required = true, example = "nice")
private String refreshToken;
@Schema(title = "用户编号", required = true, example = "666")
@Schema(description = "用户编号", required = true, example = "666")
private Long userId;
@Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
private Integer userType;
@Schema(title = "客户端编号", required = true, example = "2")
@Schema(description = "客户端编号", required = true, example = "2")
private String clientId;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
@Schema(title = "过期时间", required = true)
@Schema(description = "过期时间", required = true)
private LocalDateTime expiresTime;
}

View File

@@ -7,30 +7,30 @@ import lombok.NoArgsConstructor;
import java.util.List;
@Schema(title = "管理后台 - OAuth2 获得用户基本信息 Response VO")
@Schema(description = "管理后台 - OAuth2 获得用户基本信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2UserInfoRespVO {
@Schema(title = "用户编号", required = true, example = "1")
@Schema(description = "用户编号", required = true, example = "1")
private Long id;
@Schema(title = "用户账号", required = true, example = "芋艿")
@Schema(description = "用户账号", required = true, example = "芋艿")
private String username;
@Schema(title = "用户昵称", required = true, example = "芋道")
@Schema(description = "用户昵称", required = true, example = "芋道")
private String nickname;
@Schema(title = "用户邮箱", example = "yudao@iocoder.cn")
@Schema(description = "用户邮箱", example = "yudao@iocoder.cn")
private String email;
@Schema(title = "手机号码", example = "15601691300")
@Schema(description = "手机号码", example = "15601691300")
private String mobile;
@Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类")
@Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1")
private Integer sex;
@Schema(title = "用户头像", example = "https://www.iocoder.cn/xxx.png")
@Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png")
private String avatar;
/**
@@ -43,26 +43,26 @@ public class OAuth2UserInfoRespVO {
*/
private List<Post> posts;
@Schema(title = "部门")
@Schema(description = "部门")
@Data
public static class Dept {
@Schema(title = "部门编号", required = true, example = "1")
@Schema(description = "部门编号", required = true, example = "1")
private Long id;
@Schema(title = "部门名称", required = true, example = "研发部")
@Schema(description = "部门名称", required = true, example = "研发部")
private String name;
}
@Schema(title = "岗位")
@Schema(description = "岗位")
@Data
public static class Post {
@Schema(title = "岗位编号", required = true, example = "1")
@Schema(description = "岗位编号", required = true, example = "1")
private Long id;
@Schema(title = "岗位名称", required = true, example = "开发")
@Schema(description = "岗位名称", required = true, example = "开发")
private String name;
}

View File

@@ -9,26 +9,26 @@ import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Email;
import javax.validation.constraints.Size;
@Schema(title = "管理后台 - OAuth2 更新用户基本信息 Request VO")
@Schema(description = "管理后台 - OAuth2 更新用户基本信息 Request VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2UserUpdateReqVO {
@Schema(title = "用户昵称", required = true, example = "芋艿")
@Schema(description = "用户昵称", required = true, example = "芋艿")
@Size(max = 30, message = "用户昵称长度不能超过 30 个字符")
private String nickname;
@Schema(title = "用户邮箱", example = "yudao@iocoder.cn")
@Schema(description = "用户邮箱", example = "yudao@iocoder.cn")
@Email(message = "邮箱格式不正确")
@Size(max = 50, message = "邮箱长度不能超过 50 个字符")
private String email;
@Schema(title = "手机号码", example = "15601691300")
@Schema(description = "手机号码", example = "15601691300")
@Length(min = 11, max = 11, message = "手机号长度必须 11 位")
private String mobile;
@Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类")
@Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1")
private Integer sex;
}

View File

@@ -14,46 +14,46 @@ import javax.validation.constraints.Size;
@Data
public class MenuBaseVO {
@Schema(title = "菜单名称", required = true, example = "芋道")
@Schema(description = "菜单名称", required = true, example = "芋道")
@NotBlank(message = "菜单名称不能为空")
@Size(max = 50, message = "菜单名称长度不能超过50个字符")
private String name;
@Schema(title = "权限标识", example = "sys:menu:add", description = "仅菜单类型为按钮时,才需要传递")
@Schema(description = "权限标识,仅菜单类型为按钮时,才需要传递", example = "sys:menu:add")
@Size(max = 100)
private String permission;
@Schema(title = "类型", required = true, example = "1", description = "参见 MenuTypeEnum 枚举类")
@Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1")
@NotNull(message = "菜单类型不能为空")
private Integer type;
@Schema(title = "显示顺序不能为空", required = true, example = "1024")
@Schema(description = "显示顺序不能为空", required = true, example = "1024")
@NotNull(message = "显示顺序不能为空")
private Integer sort;
@Schema(title = "父菜单 ID", required = true, example = "1024")
@Schema(description = "父菜单 ID", required = true, example = "1024")
@NotNull(message = "父菜单 ID 不能为空")
private Long parentId;
@Schema(title = "路由地址", example = "post", description = "仅菜单类型为菜单或者目录时,才需要传")
@Schema(description = "路由地址,仅菜单类型为菜单或者目录时,才需要传", example = "post")
@Size(max = 200, message = "路由地址不能超过200个字符")
private String path;
@Schema(title = "菜单图标", example = "/menu/list", description = "仅菜单类型为菜单或者目录时,才需要传")
@Schema(description = "菜单图标,仅菜单类型为菜单或者目录时,才需要传", example = "/menu/list")
private String icon;
@Schema(title = "组件路径", example = "system/post/index", description = "仅菜单类型为菜单时,才需要传")
@Schema(description = "组件路径,仅菜单类型为菜单时,才需要传", example = "system/post/index")
@Size(max = 200, message = "组件路径不能超过255个字符")
private String component;
@Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;
@Schema(title = "是否可见", example = "false")
@Schema(description = "是否可见", example = "false")
private Boolean visible;
@Schema(title = "是否缓存", example = "false")
@Schema(description = "是否缓存", example = "false")
private Boolean keepAlive;
}

View File

@@ -3,7 +3,7 @@ package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
@Schema(title = "管理后台 - 菜单创建 Request VO")
@Schema(description = "管理后台 - 菜单创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class MenuCreateReqVO extends MenuBaseVO {

View File

@@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Schema(title = "管理后台 - 菜单列表 Request VO")
@Schema(description = "管理后台 - 菜单列表 Request VO")
@Data
public class MenuListReqVO {
@Schema(title = "菜单名称", example = "芋道", description = "模糊匹配")
@Schema(description = "菜单名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

View File

@@ -8,20 +8,20 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 菜单信息 Response VO")
@Schema(description = "管理后台 - 菜单信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class MenuRespVO extends MenuBaseVO {
@Schema(title = "菜单编号", required = true, example = "1024")
@Schema(description = "菜单编号", required = true, example = "1024")
private Long id;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -7,22 +7,22 @@ import lombok.NoArgsConstructor;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 菜单精简信息 Response VO")
@Schema(description = "管理后台 - 菜单精简信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class MenuSimpleRespVO {
@Schema(title = "菜单编号", required = true, example = "1024")
@Schema(description = "菜单编号", required = true, example = "1024")
private Long id;
@Schema(title = "菜单名称", required = true, example = "芋道")
@Schema(description = "菜单名称", required = true, example = "芋道")
private String name;
@Schema(title = "父菜单 ID", required = true, example = "1024")
@Schema(description = "父菜单 ID", required = true, example = "1024")
private Long parentId;
@Schema(title = "类型", required = true, example = "1", description = "参见 MenuTypeEnum 枚举类")
@Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1")
private Integer type;
}

View File

@@ -5,12 +5,12 @@ import lombok.*;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 菜单更新 Request VO")
@Schema(description = "管理后台 - 菜单更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class MenuUpdateReqVO extends MenuBaseVO {
@Schema(title = "菜单编号", required = true, example = "1024")
@Schema(description = "菜单编号", required = true, example = "1024")
@NotNull(message = "菜单编号不能为空")
private Long id;

View File

@@ -7,20 +7,20 @@ import javax.validation.constraints.NotNull;
import java.util.Collections;
import java.util.Set;
@Schema(title = "管理后台 - 赋予角色数据权限 Request VO")
@Schema(description = "管理后台 - 赋予角色数据权限 Request VO")
@Data
public class PermissionAssignRoleDataScopeReqVO {
@Schema(title = "角色编号", required = true, example = "1")
@Schema(description = "角色编号", required = true, example = "1")
@NotNull(message = "角色编号不能为空")
private Long roleId;
@Schema(title = "数据范围", required = true, example = "1", description = "参见 DataScopeEnum 枚举类")
@Schema(description = "数据范围,参见 DataScopeEnum 枚举类", required = true, example = "1")
@NotNull(message = "数据范围不能为空")
// TODO 这里要多一个枚举校验
private Integer dataScope;
@Schema(title = "部门编号列表", example = "1,3,5", description = "只有范围类型为 DEPT_CUSTOM 时,该字段才需要")
@Schema(description = "部门编号列表,只有范围类型为 DEPT_CUSTOM 时,该字段才需要", example = "1,3,5")
private Set<Long> dataScopeDeptIds = Collections.emptySet(); // 兜底
}

View File

@@ -7,15 +7,15 @@ import javax.validation.constraints.NotNull;
import java.util.Collections;
import java.util.Set;
@Schema(title = "管理后台 - 赋予角色菜单 Request VO")
@Schema(description = "管理后台 - 赋予角色菜单 Request VO")
@Data
public class PermissionAssignRoleMenuReqVO {
@Schema(title = "角色编号", required = true, example = "1")
@Schema(description = "角色编号", required = true, example = "1")
@NotNull(message = "角色编号不能为空")
private Long roleId;
@Schema(title = "菜单编号列表", example = "1,3,5")
@Schema(description = "菜单编号列表", example = "1,3,5")
private Set<Long> menuIds = Collections.emptySet(); // 兜底
}

View File

@@ -7,15 +7,15 @@ import javax.validation.constraints.NotNull;
import java.util.Collections;
import java.util.Set;
@Schema(title = "管理后台 - 赋予用户角色 Request VO")
@Schema(description = "管理后台 - 赋予用户角色 Request VO")
@Data
public class PermissionAssignUserRoleReqVO {
@Schema(title = "用户编号", required = true, example = "1")
@Schema(description = "用户编号", required = true, example = "1")
@NotNull(message = "用户编号不能为空")
private Long userId;
@Schema(title = "角色编号列表", example = "1,3,5")
@Schema(description = "角色编号列表", example = "1,3,5")
private Set<Long> roleIds = Collections.emptySet(); // 兜底
}

View File

@@ -14,21 +14,21 @@ import javax.validation.constraints.Size;
@Data
public class RoleBaseVO {
@Schema(title = "角色名称", required = true, example = "管理员")
@Schema(description = "角色名称", required = true, example = "管理员")
@NotBlank(message = "角色名称不能为空")
@Size(max = 30, message = "角色名称长度不能超过30个字符")
private String name;
@NotBlank(message = "角色标志不能为空")
@Size(max = 100, message = "角色标志长度不能超过100个字符")
@Schema(title = "角色编码", required = true, example = "ADMIN")
@Schema(description = "角色编码", required = true, example = "ADMIN")
private String code;
@Schema(title = "显示顺序不能为空", required = true, example = "1024")
@Schema(description = "显示顺序不能为空", required = true, example = "1024")
@NotNull(message = "显示顺序不能为空")
private Integer sort;
@Schema(title = "备注", example = "我是一个角色")
@Schema(description = "备注", example = "我是一个角色")
private String remark;
}

View File

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@Schema(title = "管理后台 - 角色创建 Request VO")
@Schema(description = "管理后台 - 角色创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class RoleCreateReqVO extends RoleBaseVO {

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 RoleExportReqVO {
@Schema(title = "角色名称", example = "芋道", description = "模糊匹配")
@Schema(description = "角色名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "角色标识", example = "yudao", description = "模糊匹配")
@Schema(description = "角色标识,模糊匹配", example = "yudao")
private String code;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@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

@@ -10,21 +10,21 @@ 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)
public class RolePageReqVO extends PageParam {
@Schema(title = "角色名称", example = "芋道", description = "模糊匹配")
@Schema(description = "角色名称,模糊匹配", example = "芋道")
private String name;
@Schema(title = "角色标识", example = "yudao", description = "模糊匹配")
@Schema(description = "角色标识,模糊匹配", example = "yudao")
private String code;
@Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@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

@@ -9,29 +9,29 @@ import lombok.NoArgsConstructor;
import java.time.LocalDateTime;
import java.util.Set;
@Schema(title = "管理后台 - 角色信息 Response VO")
@Schema(description = "管理后台 - 角色信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class RoleRespVO extends RoleBaseVO {
@Schema(title = "角色编号", required = true, example = "1")
@Schema(description = "角色编号", required = true, example = "1")
private Long id;
@Schema(title = "数据范围", required = true, example = "1", description = "参见 DataScopeEnum 枚举类")
@Schema(description = "数据范围,参见 DataScopeEnum 枚举类", required = true, example = "1")
private Integer dataScope;
@Schema(title = "数据范围(指定部门数组)", example = "1")
@Schema(description = "数据范围(指定部门数组)", example = "1")
private Set<Long> dataScopeDeptIds;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(title = "角色类型", required = true, example = "1", description = "参见 RoleTypeEnum 枚举类")
@Schema(description = "角色类型,参见 RoleTypeEnum 枚举类", required = true, example = "1")
private Integer type;
@Schema(title = "创建时间", required = true, example = "时间戳格式")
@Schema(description = "创建时间", required = true, example = "时间戳格式")
private LocalDateTime createTime;
}

View File

@@ -5,16 +5,16 @@ import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Schema(title = "管理后台 - 角色精简信息 Response VO")
@Schema(description = "管理后台 - 角色精简信息 Response VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class RoleSimpleRespVO {
@Schema(title = "角色编号", required = true, example = "1024")
@Schema(description = "角色编号", required = true, example = "1024")
private Long id;
@Schema(title = "角色名称", required = true, example = "芋道")
@Schema(description = "角色名称", required = true, example = "芋道")
private String name;
}

View File

@@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 角色更新 Request VO")
@Schema(description = "管理后台 - 角色更新 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class RoleUpdateReqVO extends RoleBaseVO {
@Schema(title = "角色编号", required = true, example = "1024")
@Schema(description = "角色编号", required = true, example = "1024")
@NotNull(message = "角色编号不能为空")
private Long id;

View File

@@ -7,15 +7,15 @@ import lombok.Data;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 角色更新状态 Request VO")
@Schema(description = "管理后台 - 角色更新状态 Request VO")
@Data
public class RoleUpdateStatusReqVO {
@Schema(title = "角色编号", required = true, example = "1024")
@Schema(description = "角色编号", required = true, example = "1024")
@NotNull(message = "角色编号不能为空")
private Long id;
@Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
@InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}")
private Integer status;

View File

@@ -13,19 +13,19 @@ import java.util.List;
@Data
public class SensitiveWordBaseVO {
@Schema(title = "敏感词", required = true, example = "敏感词")
@Schema(description = "敏感词", required = true, example = "敏感词")
@NotNull(message = "敏感词不能为空")
private String name;
@Schema(title = "标签", required = true, example = "短信,评论")
@Schema(description = "标签", required = true, example = "短信,评论")
@NotNull(message = "标签不能为空")
private List<String> tags;
@Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;
@Schema(title = "描述", example = "污言秽语")
@Schema(description = "描述", example = "污言秽语")
private String description;
}

View File

@@ -5,7 +5,7 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 敏感词创建 Request VO")
@Schema(description = "管理后台 - 敏感词创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

View File

@@ -8,21 +8,21 @@ 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 = "参数和 SensitiveWordPageReqVO 是一致的")
@Schema(description = "管理后台 - 敏感词 Excel 导出 Request VO,参数和 SensitiveWordPageReqVO 是一致的")
@Data
public class SensitiveWordExportReqVO {
@Schema(title = "敏感词", example = "敏感词")
@Schema(description = "敏感词", example = "敏感词")
private String name;
@Schema(title = "标签", example = "短信,评论")
@Schema(description = "标签", example = "短信,评论")
private String tag;
@Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -11,23 +11,23 @@ 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 SensitiveWordPageReqVO extends PageParam {
@Schema(title = "敏感词", example = "敏感词")
@Schema(description = "敏感词", example = "敏感词")
private String name;
@Schema(title = "标签", example = "短信,评论")
@Schema(description = "标签", example = "短信,评论")
private String tag;
@Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

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 SensitiveWordRespVO extends SensitiveWordBaseVO {
@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

@@ -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 SensitiveWordUpdateReqVO extends SensitiveWordBaseVO {
@Schema(title = "编号", required = true, example = "1")
@Schema(description = "编号", required = true, example = "1")
@NotNull(message = "编号不能为空")
private Long id;

View File

@@ -12,25 +12,25 @@ import javax.validation.constraints.NotNull;
@Data
public class SmsChannelBaseVO {
@Schema(title = "短信签名", required = true, example = "芋道源码")
@Schema(description = "短信签名", required = true, example = "芋道源码")
@NotNull(message = "短信签名不能为空")
private String signature;
@Schema(title = "启用状态", required = true, example = "1")
@Schema(description = "启用状态", required = true, example = "1")
@NotNull(message = "启用状态不能为空")
private Integer status;
@Schema(title = "备注", example = "好吃!")
@Schema(description = "备注", example = "好吃!")
private String remark;
@Schema(title = "短信 API 的账号", required = true, example = "yudao")
@Schema(description = "短信 API 的账号", required = true, example = "yudao")
@NotNull(message = "短信 API 的账号不能为空")
private String apiKey;
@Schema(title = "短信 API 的密钥", example = "yuanma")
@Schema(description = "短信 API 的密钥", example = "yuanma")
private String apiSecret;
@Schema(title = "短信发送回调 URL", example = "http://www.iocoder.cn")
@Schema(description = "短信发送回调 URL", example = "http://www.iocoder.cn")
@URL(message = "回调 URL 格式不正确")
private String callbackUrl;

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 SmsChannelCreateReqVO extends SmsChannelBaseVO {
@Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN")
@NotNull(message = "渠道编码不能为空")
private String code;

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 SmsChannelPageReqVO extends PageParam {
@Schema(title = "任务状态", example = "1")
@Schema(description = "任务状态", example = "1")
private Integer status;
@Schema(title = "短信签名", example = "芋道源码", description = "模糊匹配")
@Schema(description = "短信签名,模糊匹配", example = "芋道源码")
private String signature;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "创建时间")
@Schema(description = "创建时间")
private LocalDateTime[] createTime;
}

View File

@@ -7,19 +7,19 @@ import lombok.ToString;
import java.time.LocalDateTime;
@Schema(title = "管理后台 - 短信渠道 Response VO")
@Schema(description = "管理后台 - 短信渠道 Response VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class SmsChannelRespVO extends SmsChannelBaseVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
private Long id;
@Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN")
private String code;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -5,19 +5,19 @@ import lombok.Data;
import javax.validation.constraints.NotNull;
@Schema(title = "管理后台 - 短信渠道精简 Response VO")
@Schema(description = "管理后台 - 短信渠道精简 Response VO")
@Data
public class SmsChannelSimpleRespVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
@NotNull(message = "编号不能为空")
private Long id;
@Schema(title = "短信签名", required = true, example = "芋道源码")
@Schema(description = "短信签名", required = true, example = "芋道源码")
@NotNull(message = "短信签名不能为空")
private String signature;
@Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN")
private String code;
}

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 SmsChannelUpdateReqVO extends SmsChannelBaseVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
@NotNull(message = "编号不能为空")
private Long id;

View File

@@ -8,31 +8,31 @@ 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 = "参数和 SmsLogPageReqVO 是一致的")
@Schema(description = "管理后台 - 短信日志 Excel 导出 Request VO,参数和 SmsLogPageReqVO 是一致的")
@Data
public class SmsLogExportReqVO {
@Schema(title = "短信渠道编号", example = "10")
@Schema(description = "短信渠道编号", example = "10")
private Long channelId;
@Schema(title = "模板编号", example = "20")
@Schema(description = "模板编号", example = "20")
private Long templateId;
@Schema(title = "手机号", example = "15601691300")
@Schema(description = "手机号", example = "15601691300")
private String mobile;
@Schema(title = "发送状态", example = "1")
@Schema(description = "发送状态", example = "1")
private Integer sendStatus;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始发送时间")
@Schema(description = "开始发送时间")
private LocalDateTime[] sendTime;
@Schema(title = "接收状态", example = "0")
@Schema(description = "接收状态", example = "0")
private Integer receiveStatus;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "开始接收时间")
@Schema(description = "开始接收时间")
private LocalDateTime[] receiveTime;
}

View File

@@ -11,33 +11,33 @@ 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 SmsLogPageReqVO extends PageParam {
@Schema(title = "短信渠道编号", example = "10")
@Schema(description = "短信渠道编号", example = "10")
private Long channelId;
@Schema(title = "模板编号", example = "20")
@Schema(description = "模板编号", example = "20")
private Long templateId;
@Schema(title = "手机号", example = "15601691300")
@Schema(description = "手机号", example = "15601691300")
private String mobile;
@Schema(title = "发送状态", example = "1", description = "参见 SmsSendStatusEnum 枚举类")
@Schema(description = "发送状态,参见 SmsSendStatusEnum 枚举类", example = "1")
private Integer sendStatus;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "发送时间")
@Schema(description = "发送时间")
private LocalDateTime[] sendTime;
@Schema(title = "接收状态", example = "0", description = "参见 SmsReceiveStatusEnum 枚举类")
@Schema(description = "接收状态,参见 SmsReceiveStatusEnum 枚举类", example = "0")
private Integer receiveStatus;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
@Schema(title = "接收时间")
@Schema(description = "接收时间")
private LocalDateTime[] receiveTime;
}

View File

@@ -6,83 +6,83 @@ import lombok.Data;
import java.time.LocalDateTime;
import java.util.Map;
@Schema(title = "管理后台 - 短信日志 Response VO")
@Schema(description = "管理后台 - 短信日志 Response VO")
@Data
public class SmsLogRespVO {
@Schema(title = "编号", required = true, example = "1024")
@Schema(description = "编号", required = true, example = "1024")
private Long id;
@Schema(title = "短信渠道编号", required = true, example = "10")
@Schema(description = "短信渠道编号", required = true, example = "10")
private Long channelId;
@Schema(title = "短信渠道编码", required = true, example = "ALIYUN")
@Schema(description = "短信渠道编码", required = true, example = "ALIYUN")
private String channelCode;
@Schema(title = "模板编号", required = true, example = "20")
@Schema(description = "模板编号", required = true, example = "20")
private Long templateId;
@Schema(title = "模板编码", required = true, example = "test-01")
@Schema(description = "模板编码", required = true, example = "test-01")
private String templateCode;
@Schema(title = "短信类型", required = true, example = "1")
@Schema(description = "短信类型", required = true, example = "1")
private Integer templateType;
@Schema(title = "短信内容", required = true, example = "你好,你的验证码是 1024")
@Schema(description = "短信内容", required = true, example = "你好,你的验证码是 1024")
private String templateContent;
@Schema(title = "短信参数", required = true, example = "name,code")
@Schema(description = "短信参数", required = true, example = "name,code")
private Map<String, Object> templateParams;
@Schema(title = "短信 API 的模板编号", required = true, example = "SMS_207945135")
@Schema(description = "短信 API 的模板编号", required = true, example = "SMS_207945135")
private String apiTemplateId;
@Schema(title = "手机号", required = true, example = "15601691300")
@Schema(description = "手机号", required = true, example = "15601691300")
private String mobile;
@Schema(title = "用户编号", example = "10")
@Schema(description = "用户编号", example = "10")
private Long userId;
@Schema(title = "用户类型", example = "1")
@Schema(description = "用户类型", example = "1")
private Integer userType;
@Schema(title = "发送状态", required = true, example = "1")
@Schema(description = "发送状态", required = true, example = "1")
private Integer sendStatus;
@Schema(title = "发送时间")
@Schema(description = "发送时间")
private LocalDateTime sendTime;
@Schema(title = "发送结果的编码", example = "0")
@Schema(description = "发送结果的编码", example = "0")
private Integer sendCode;
@Schema(title = "发送结果的提示", example = "成功")
@Schema(description = "发送结果的提示", example = "成功")
private String sendMsg;
@Schema(title = "短信 API 发送结果的编码", example = "SUCCESS")
@Schema(description = "短信 API 发送结果的编码", example = "SUCCESS")
private String apiSendCode;
@Schema(title = "短信 API 发送失败的提示", example = "成功")
@Schema(description = "短信 API 发送失败的提示", example = "成功")
private String apiSendMsg;
@Schema(title = "短信 API 发送返回的唯一请求 ID", example = "3837C6D3-B96F-428C-BBB2-86135D4B5B99")
@Schema(description = "短信 API 发送返回的唯一请求 ID", example = "3837C6D3-B96F-428C-BBB2-86135D4B5B99")
private String apiRequestId;
@Schema(title = "短信 API 发送返回的序号", example = "62923244790")
@Schema(description = "短信 API 发送返回的序号", example = "62923244790")
private String apiSerialNo;
@Schema(title = "接收状态", required = true, example = "0")
@Schema(description = "接收状态", required = true, example = "0")
private Integer receiveStatus;
@Schema(title = "接收时间")
@Schema(description = "接收时间")
private LocalDateTime receiveTime;
@Schema(title = "API 接收结果的编码", example = "DELIVRD")
@Schema(description = "API 接收结果的编码", example = "DELIVRD")
private String apiReceiveCode;
@Schema(title = "API 接收结果的说明", example = "用户接收成功")
@Schema(description = "API 接收结果的说明", example = "用户接收成功")
private String apiReceiveMsg;
@Schema(title = "创建时间", required = true)
@Schema(description = "创建时间", required = true)
private LocalDateTime createTime;
}

View File

@@ -11,34 +11,34 @@ import javax.validation.constraints.NotNull;
@Data
public class SmsTemplateBaseVO {
@Schema(title = "短信类型", required = true, example = "1", description = "参见 SmsTemplateTypeEnum 枚举类")
@Schema(description = "短信类型,参见 SmsTemplateTypeEnum 枚举类", required = true, example = "1")
@NotNull(message = "短信类型不能为空")
private Integer type;
@Schema(title = "开启状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类")
@Schema(description = "开启状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
@NotNull(message = "开启状态不能为空")
private Integer status;
@Schema(title = "模板编码", required = true, example = "test_01")
@Schema(description = "模板编码", required = true, example = "test_01")
@NotNull(message = "模板编码不能为空")
private String code;
@Schema(title = "模板名称", required = true, example = "yudao")
@Schema(description = "模板名称", required = true, example = "yudao")
@NotNull(message = "模板名称不能为空")
private String name;
@Schema(title = "模板内容", required = true, example = "你好,{name}。你长的太{like}啦!")
@Schema(description = "模板内容", required = true, example = "你好,{name}。你长的太{like}啦!")
@NotNull(message = "模板内容不能为空")
private String content;
@Schema(title = "备注", example = "哈哈哈")
@Schema(description = "备注", example = "哈哈哈")
private String remark;
@Schema(title = "短信 API 的模板编号", required = true, example = "4383920")
@Schema(description = "短信 API 的模板编号", required = true, example = "4383920")
@NotNull(message = "短信 API 的模板编号不能为空")
private String apiTemplateId;
@Schema(title = "短信渠道编号", required = true, example = "10")
@Schema(description = "短信渠道编号", required = true, example = "10")
@NotNull(message = "短信渠道编号不能为空")
private Long channelId;

View File

@@ -4,7 +4,7 @@ import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@Schema(title = "管理后台 - 短信模板创建 Request VO")
@Schema(description = "管理后台 - 短信模板创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

Some files were not shown because too many files have changed in this diff Show More