ContiNew/continew-admin
1
1
Fork 0
mirror of https://github.com/continew-org/continew-admin.git synced 2025-10-31 10:57:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8 from Bull-BCLS/dev

Browse Source 
docs: 完善系统监控模块相关接口文档信息
This commit is contained in:
Charles7c
2023-08-15 22:53:20 +08:00
committed by GitHub
parent fa916b9324 0ac0213628
commit 6a35c00b7a
9 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/query/LoginLogQuery.java
View File

@@ -46,14 +46,14 @@ public class LoginLogQuery implements Serializable {
/** /**
* 登录状态（1：成功，2：失败） * 登录状态（1：成功，2：失败）
*/ */
@Schema(description = "登录状态（1：成功，2：失败）") @Schema(description = "登录状态（1：成功，2：失败）", example = "1")
@Query @Query
private Integer status; private Integer status;
/** /**
* 登录时间 * 登录时间
*/ */
@Schema(description = "登录时间") @Schema(description = "登录时间", example = "2023-08-08 00:00:00,2023-08-08 23:59:59")
@Query(type = QueryTypeEnum.BETWEEN) @Query(type = QueryTypeEnum.BETWEEN)
@DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN) @DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN)
private List<Date> createTime; private List<Date> createTime;

8
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/query/OperationLogQuery.java
View File

@@ -46,21 +46,21 @@ public class OperationLogQuery implements Serializable {
/** /**
* 操作内容 * 操作内容
*/ */
@Schema(description = "操作内容") @Schema(description = "操作内容", example = "新增数据")
@Query(type = QueryTypeEnum.INNER_LIKE) @Query(type = QueryTypeEnum.INNER_LIKE)
private String description; private String description;
/** /**
* 操作状态（1：成功，2：失败） * 操作状态（1：成功，2：失败）
*/ */
@Schema(description = "操作状态（1：成功，2：失败）") @Schema(description = "操作状态（1：成功，2：失败）", example = "1")
@Query @Query
private Integer status; private Integer status;
/** /**
* 操作时间 * 操作时间
*/ */
@Schema(description = "操作时间") @Schema(description = "操作时间", example = "2023-08-08 00:00:00,2023-08-08 23:59:59")
@Query(type = QueryTypeEnum.BETWEEN) @Query(type = QueryTypeEnum.BETWEEN)
@DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN) @DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN)
private List<Date> createTime; private List<Date> createTime;
@@ -68,7 +68,7 @@ public class OperationLogQuery implements Serializable {
/** /**
* 操作人 * 操作人
*/ */
@Schema(description = "操作人") @Schema(description = "操作人", example = "张三")
@Query(property = "createUser") @Query(property = "createUser")
private Long uid; private Long uid;
} }

2
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/query/SystemLogQuery.java
View File

@@ -46,7 +46,7 @@ public class SystemLogQuery implements Serializable {
/** /**
* 创建时间 * 创建时间
*/ */
@Schema(description = "创建时间") @Schema(description = "创建时间", example = "2023-08-08 00:00:00,2023-08-08 23:59:59")
@Query(type = QueryTypeEnum.BETWEEN) @Query(type = QueryTypeEnum.BETWEEN)
@DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN) @DateTimeFormat(pattern = DatePattern.NORM_DATETIME_PATTERN)
private List<Date> createTime; private List<Date> createTime;

6
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/vo/LogVO.java
View File

@@ -39,7 +39,7 @@ public class LogVO implements Serializable {
/** /**
* ID * ID
*/ */
@Schema(description = "ID") @Schema(description = "ID", example = "1")
private Long id; private Long id;
/** /**
@@ -51,12 +51,12 @@ public class LogVO implements Serializable {
/** /**
* 创建人 * 创建人
*/ */
@Schema(description = "创建人") @Schema(description = "创建人", example = "张三")
private String createUserString; private String createUserString;
/** /**
* 创建时间 * 创建时间
*/ */
@Schema(description = "创建时间") @Schema(description = "创建时间", example = "2023-08-08 08:08:08")
private LocalDateTime createTime; private LocalDateTime createTime;
} }

10
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/vo/LoginLogVO.java
View File

@@ -37,31 +37,31 @@ public class LoginLogVO extends LogVO {
/** /**
* 登录行为 * 登录行为
*/ */
@Schema(description = "登录行为") @Schema(description = "登录行为", example = "用户登录")
private String description; private String description;
/** /**
* 登录状态（1：成功，2：失败） * 登录状态（1：成功，2：失败）
*/ */
@Schema(description = "登录状态（1：成功，2：失败）", type = "Integer", allowableValues = {"1", "2"}) @Schema(description = "登录状态（1：成功，2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
private LogStatusEnum status; private LogStatusEnum status;
/** /**
* 登录 IP * 登录 IP
*/ */
@Schema(description = "登录 IP") @Schema(description = "登录 IP", example = "192.168.0.1")
private String clientIp; private String clientIp;
/** /**
* 登录地点 * 登录地点
*/ */
@Schema(description = "登录地点") @Schema(description = "登录地点", example = "中国北京北京市")
private String location; private String location;
/** /**
* 浏览器 * 浏览器
*/ */
@Schema(description = "浏览器") @Schema(description = "浏览器", example = "Chrome 115.0.0.0")
private String browser; private String browser;
/** /**

12
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/vo/OperationLogVO.java
View File

@@ -37,37 +37,37 @@ public class OperationLogVO extends LogVO {
/** /**
* 操作内容 * 操作内容
*/ */
@Schema(description = "操作内容") @Schema(description = "操作内容", example = "新增数据")
private String description; private String description;
/** /**
* 所属模块 * 所属模块
*/ */
@Schema(description = "所属模块") @Schema(description = "所属模块", example = "部门管理")
private String module; private String module;
/** /**
* 操作状态（1成功 2失败） * 操作状态（1成功 2失败）
*/ */
@Schema(description = "操作状态（1：成功，2：失败）", type = "Integer", allowableValues = {"1", "2"}) @Schema(description = "操作状态（1：成功，2：失败）", type = "Integer", allowableValues = {"1", "2"}, example = "1")
private LogStatusEnum status; private LogStatusEnum status;
/** /**
* 操作IP * 操作IP
*/ */
@Schema(description = "操作IP") @Schema(description = "操作IP", example = "192.168.0.1")
private String clientIp; private String clientIp;
/** /**
* 操作地点 * 操作地点
*/ */
@Schema(description = "操作地点") @Schema(description = "操作地点", example = "中国北京北京市")
private String location; private String location;
/** /**
* 浏览器 * 浏览器
*/ */
@Schema(description = "浏览器") @Schema(description = "浏览器", example = "Chrome 115.0.0.0")
private String browser; private String browser;
/** /**

22
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/vo/SystemLogDetailVO.java
View File

@@ -35,66 +35,66 @@ public class SystemLogDetailVO extends LogVO {
/** /**
* 状态码 * 状态码
*/ */
@Schema(description = "状态码") @Schema(description = "状态码", example = "200")
private Integer statusCode; private Integer statusCode;
/** /**
* 请求方式 * 请求方式
*/ */
@Schema(description = "请求方式") @Schema(description = "请求方式", example = "POST")
private String requestMethod; private String requestMethod;
/** /**
* 请求 URL * 请求 URL
*/ */
@Schema(description = "请求 URL") @Schema(description = "请求 URL", example = "http://api.charles7c.top/system/dept")
private String requestUrl; private String requestUrl;
/** /**
* 请求头 * 请求头
*/ */
@Schema(description = "请求头") @Schema(description = "请求头", example = "{\"Origin\": \"https://cnadmin.charles7c.top\",...}")
private String requestHeaders; private String requestHeaders;
/** /**
* 请求体 * 请求体
*/ */
@Schema(description = "请求体") @Schema(description = "请求体", example = "{\"name\": \"测试部\",...}")
private String requestBody; private String requestBody;
/** /**
* 响应头 * 响应头
*/ */
@Schema(description = "响应头") @Schema(description = "响应头", example = "{\"Content-Type\": [\"application/json\"],...}")
private String responseHeaders; private String responseHeaders;
/** /**
* 响应体 * 响应体
*/ */
@Schema(description = "响应体") @Schema(description = "响应体", example = "{\"success\":true},...")
private String responseBody; private String responseBody;
/** /**
* 客户端IP * 客户端IP
*/ */
@Schema(description = "客户端IP") @Schema(description = "客户端IP", example = "192.168.0.1")
private String clientIp; private String clientIp;
/** /**
* IP归属地 * IP归属地
*/ */
@Schema(description = "IP归属地") @Schema(description = "IP归属地", example = "中国北京北京市")
private String location; private String location;
/** /**
* 浏览器 * 浏览器
*/ */
@Schema(description = "浏览器") @Schema(description = "浏览器", example = "Chrome 115.0.0.0")
private String browser; private String browser;
/** /**
* 请求耗时（ms） * 请求耗时（ms）
*/ */
@Schema(description = "请求耗时（ms）") @Schema(description = "请求耗时（ms）", example = "58")
private Long elapsedTime; private Long elapsedTime;
} }

14
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/model/vo/SystemLogVO.java
View File

@@ -35,43 +35,43 @@ public class SystemLogVO extends LogVO {
/** /**
* 状态码 * 状态码
*/ */
@Schema(description = "状态码") @Schema(description = "状态码", example = "200")
private Integer statusCode; private Integer statusCode;
/** /**
* 请求方式 * 请求方式
*/ */
@Schema(description = "请求方式") @Schema(description = "请求方式", example = "POST")
private String requestMethod; private String requestMethod;
/** /**
* 请求 URL * 请求 URL
*/ */
@Schema(description = "请求 URL") @Schema(description = "请求 URL", example = "http://api.charles7c.top/system/dept")
private String requestUrl; private String requestUrl;
/** /**
* 客户端IP * 客户端IP
*/ */
@Schema(description = "客户端IP") @Schema(description = "客户端IP", example = "192.168.0.1")
private String clientIp; private String clientIp;
/** /**
* IP归属地 * IP归属地
*/ */
@Schema(description = "IP归属地") @Schema(description = "IP归属地", example = "中国北京北京市")
private String location; private String location;
/** /**
* 浏览器 * 浏览器
*/ */
@Schema(description = "浏览器") @Schema(description = "浏览器", example = "Chrome 115.0.0.0")
private String browser; private String browser;
/** /**
* 请求耗时（ms） * 请求耗时（ms）
*/ */
@Schema(description = "请求耗时（ms）") @Schema(description = "请求耗时（ms）", example = "58")
private Long elapsedTime; private Long elapsedTime;
/** /**

6
continew-admin-system/src/main/java/top/charles7c/cnadmin/auth/model/vo/UserInfoVO.java
View File

@@ -89,7 +89,7 @@ public class UserInfoVO implements Serializable {
/** /**
* 描述 * 描述
*/ */
@Schema(description = "描述", example = "张三用户") @Schema(description = "描述", example = "张三描述信息")
private String description; private String description;
/** /**
@@ -126,13 +126,13 @@ public class UserInfoVO implements Serializable {
/** /**
* 权限码集合 * 权限码集合
*/ */
@Schema(description = "权限码集合", example = "[system:user:list,system:user:add]") @Schema(description = "权限码集合", example = "[\"system:user:list\",\"system:user:add\"]")
private Set<String> permissions; private Set<String> permissions;
/** /**
* 角色编码集合 * 角色编码集合
*/ */
@Schema(description = "角色编码集合", example = "[admin,test]") @Schema(description = "角色编码集合", example = "[\"test\"]")
private Set<String> roles; private Set<String> roles;
public String getPhone() { public String getPhone() {