Change namespace to top.fatweb.oxygen.api

This commit is contained in:
2023-12-28 13:39:42 +08:00
parent 605f3f4152
commit 47baa06125
231 changed files with 698 additions and 682 deletions

View File

@@ -0,0 +1,57 @@
package top.fatweb.oxygen.api.vo
import io.swagger.v3.oas.annotations.media.Schema
/**
* Page value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "分页返回参数")
data class PageVo<T>(
/**
* Total number of records
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总数量", example = "100")
val total: Long,
/**
* Total number of pages
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总页码", example = "10")
val pages: Long,
/**
* Size of page
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "分页大小", example = "10")
val size: Long,
/**
* Current page number
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "当前页码", example = "2")
val current: Long,
/**
* Records in current page
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "数据")
val records: List<T>
)

View File

@@ -0,0 +1,21 @@
package top.fatweb.oxygen.api.vo.api.v1.avatar
import io.swagger.v3.oas.annotations.media.Schema
/**
* Avatar base64 value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "头像 Base64 返回参数")
data class AvatarBase64Vo(
/**
* Base64
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "base64")
val base64: String?
)

View File

@@ -0,0 +1,72 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.RoleVo
import java.time.LocalDateTime
/**
* Group with role value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
data class GroupWithRoleVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户组名", example = "Role")
val name: String?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "启用", example = "true")
val enable: Boolean?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* List of RoleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see RoleVo
*/
@Schema(description = "角色列表")
val roles: List<RoleVo>?
)

View File

@@ -0,0 +1,62 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import java.time.LocalDateTime
/**
* Login value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "登录返回参数")
data class LoginVo(
/**
* Token
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(
description = "Token",
example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkYTllYjFkYmVmZDQ0OWRkOThlOGNjNzZlNzZkMDgyNSIsInN1YiI6IjE3MDk5ODYwNTg2Nzk5NzU5MzgiLCJpc3MiOiJGYXRXZWIiLCJpYXQiOjE2OTY1MjgxMTcsImV4cCI6MTY5NjUzNTMxN30.U2ZsyrGk7NbsP-DJfdz9xgWSfect5r2iKQnlEsscAA8"
) val token: String,
/**
* User ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(
description = "User ID",
example = "1709986058679975938"
)
@JsonSerialize(using = ToStringSerializer::class)
val userId: Long?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(
description = "上次登录时间",
example = "1900-01-01 00:00:00"
) val lastLoginTime: LocalDateTime?,
/**
* Last login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(
description = "上次登录 IP",
example = "10.0.0.1"
) val lastLoginIp: String?
)

View File

@@ -0,0 +1,56 @@
package top.fatweb.oxygen.api.vo.permission
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.FuncVo
import top.fatweb.oxygen.api.vo.permission.base.MenuVo
import top.fatweb.oxygen.api.vo.permission.base.ModuleVo
import top.fatweb.oxygen.api.vo.permission.base.OperationVo
/**
* Set of power value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "权限集合返回参数")
data class PowerSetVo(
/**
* List of ModuleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see ModuleVo
*/
@Schema(description = "模块列表")
val moduleList: List<ModuleVo>?,
/**
* List of MenuVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see MenuVo
*/
@Schema(description = "菜单列表")
val menuList: List<MenuVo>?,
/**
* List of FuncVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see FuncVo
*/
@Schema(description = "功能列表")
val funcList: List<FuncVo>?,
/**
* List of OperationVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see OperationVo
*/
@Schema(description = "操作列表")
val operationList: List<OperationVo>?
)

View File

@@ -0,0 +1,24 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
/**
* Register value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "注册返回参数")
data class RegisterVo(
/**
* User ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "User ID", example = "1709986058679975938")
@JsonSerialize(using = ToStringSerializer::class)
val userId: Long?
)

View File

@@ -0,0 +1,106 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.FuncVo
import top.fatweb.oxygen.api.vo.permission.base.MenuVo
import top.fatweb.oxygen.api.vo.permission.base.ModuleVo
import top.fatweb.oxygen.api.vo.permission.base.OperationVo
import java.time.LocalDateTime
/**
* Role with power value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "角色返回参数")
data class RoleWithPowerVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "角色名", example = "Role")
val name: String?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "启用", example = "true")
val enable: Boolean?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* List of ModuleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see ModuleVo
*/
@Schema(description = "模块列表")
val modules: List<ModuleVo>?,
/**
* List of MenuVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see MenuVo
*/
@Schema(description = "菜单列表")
val menus: List<MenuVo>?,
/**
* List of FuncVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see FuncVo
*/
@Schema(description = "功能列表")
val funcs: List<FuncVo>?,
/**
* List of OperationVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see OperationVo
*/
@Schema(description = "操作列表")
val operations: List<OperationVo>?
)

View File

@@ -0,0 +1,23 @@
package top.fatweb.oxygen.api.vo.permission
import io.swagger.v3.oas.annotations.media.Schema
/**
* Token value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Token 返回参数")
data class TokenVo(
/**
* Token
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(
description = "Token",
example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkYTllYjFkYmVmZDQ0OWRkOThlOGNjNzZlNzZkMDgyNSIsInN1YiI6IjE3MDk5ODYwNTg2Nzk5NzU5MzgiLCJpc3MiOiJGYXRXZWIiLCJpYXQiOjE2OTY1MjgxMTcsImV4cCI6MTY5NjUzNTMxN30.U2ZsyrGk7NbsP-DJfdz9xgWSfect5r2iKQnlEsscAA8"
) val token: String
)

View File

@@ -0,0 +1,149 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.UserInfoVo
import java.time.LocalDateTime
/**
* User with information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户信息返回参数")
data class UserWithInfoVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户名", example = "User")
val username: String?,
/**
* Verified
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "已验证", example = "true")
val verified: Boolean?,
/**
* Locking
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否锁定", example = "false")
val locking: Boolean?,
/**
* Expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "过期时间", example = "1900-01-01T00:00:00.000Z")
val expiration: LocalDateTime?,
/**
* Credentials expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "认证过期时间", example = "1900-01-01T00:00:00.000Z")
val credentialsExpiration: LocalDateTime?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否启用", example = "true")
val enable: Boolean?,
/**
* Current login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录时间", example = "1900-01-01T00:00:00.000Z")
val currentLoginTime: LocalDateTime?,
/**
* Current login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "当前登录 IP", example = "1.1.1.1")
val currentLoginIp: String?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "最后登录时间", example = "1900-01-01T00:00:00.000Z")
val lastLoginTime: LocalDateTime?,
/**
* Last login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "最后登录 IP", example = "1.1.1.1")
val lastLoginIp: String?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* User information object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see UserInfoVo
*/
@Schema(description = "用户资料")
val userInfo: UserInfoVo?
)

View File

@@ -0,0 +1,180 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.GroupVo
import top.fatweb.oxygen.api.vo.permission.base.RoleVo
import top.fatweb.oxygen.api.vo.permission.base.UserInfoVo
import java.time.LocalDateTime
/**
* User with password role information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户密码角色信息返回参数")
data class UserWithPasswordRoleInfoVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户名", example = "User")
val username: String?,
/**
* Password
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "密码")
val password: String?,
/**
* Verify
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "验证信息")
val verify: String?,
/**
* Locking
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否锁定", example = "false")
val locking: Boolean?,
/**
* Expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "过期时间", example = "1900-01-01T00:00:00.000Z")
val expiration: LocalDateTime?,
/**
* Credentials expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "认证过期时间", example = "1900-01-01T00:00:00.000Z")
val credentialsExpiration: LocalDateTime?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否启用", example = "true")
val enable: Boolean?,
/**
* Current login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录时间", example = "1900-01-01T00:00:00.000Z")
val currentLoginTime: LocalDateTime?,
/**
* Current login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "当前登录 IP", example = "1.1.1.1")
val currentLoginIp: String?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "最后登录时间", example = "1900-01-01T00:00:00.000Z")
val lastLoginTime: LocalDateTime?,
/**
* Last login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "最后登录 IP", example = "1.1.1.1")
val lastLoginIp: String?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* User information object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see UserInfoVo
*/
@Schema(description = "用户资料")
val userInfo: UserInfoVo?,
/**
* List of RoleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see RoleVo
*/
@Schema(description = "角色列表")
val roles: List<RoleVo>?,
/**
* List of GroupVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see GroupVo
*/
@Schema(description = "用户组列表")
val groups: List<GroupVo>?
)

View File

@@ -0,0 +1,186 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.*
import java.time.LocalDateTime
/**
* User with power information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户权限信息返回参数")
data class UserWithPowerInfoVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户名", example = "User")
val username: String?,
/**
* Verified
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "已验证", example = "true")
val verified: Boolean?,
/**
* Locking
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否锁定", example = "false")
val locking: Boolean?,
/**
* Expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "过期时间", example = "1900-01-01T00:00:00.000Z")
val expiration: LocalDateTime?,
/**
* Credentials expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "认证过期时间", example = "1900-01-01T00:00:00.000Z")
val credentialsExpiration: LocalDateTime?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否启用", example = "true")
val enable: Boolean?,
/**
* Current login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录时间", example = "1900-01-01T00:00:00.000Z")
val currentLoginTime: LocalDateTime?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录 IP", example = "1.1.1.1")
val currentLoginIp: String?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "最后登录时间", example = "1900-01-01T00:00:00.000Z")
val lastLoginTime: LocalDateTime?,
/**
* Last login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "最后登录 IP", example = "1.1.1.1")
val lastLoginIp: String?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* User information object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see UserInfoVo
*/
@Schema(description = "用户资料")
val userInfo: UserInfoVo?,
/**
* List of ModuleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "模块列表")
val modules: List<ModuleVo>?,
/**
* List of MenuVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "菜单列表")
val menus: List<MenuVo>?,
/**
* List of FuncVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "功能列表")
val funcs: List<FuncVo>?,
/**
* List of OperationVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作列表")
val operations: List<OperationVo>?
)

View File

@@ -0,0 +1,173 @@
package top.fatweb.oxygen.api.vo.permission
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.permission.base.GroupVo
import top.fatweb.oxygen.api.vo.permission.base.RoleVo
import top.fatweb.oxygen.api.vo.permission.base.UserInfoVo
import java.time.LocalDateTime
/**
* User with role information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户角色信息返回参数")
data class UserWithRoleInfoVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户名", example = "User")
val username: String?,
/**
* Verify
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "验证信息")
val verify: String?,
/**
* Locking
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否锁定", example = "false")
val locking: Boolean?,
/**
* Expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "过期时间", example = "1900-01-01T00:00:00.000Z")
val expiration: LocalDateTime?,
/**
* Credentials expiration time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "认证过期时间", example = "1900-01-01T00:00:00.000Z")
val credentialsExpiration: LocalDateTime?,
/**
* Current login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "是否启用", example = "true")
val enable: Boolean?,
/**
* Current login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录时间", example = "1900-01-01T00:00:00.000Z")
val currentLoginTime: LocalDateTime?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "当前登录 IP", example = "1.1.1.1")
val currentLoginIp: String?,
/**
* Last login time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "最后登录时间", example = "1900-01-01T00:00:00.000Z")
val lastLoginTime: LocalDateTime?,
/**
* Last login IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "最后登录 IP", example = "1.1.1.1")
val lastLoginIp: String?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* User information object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see UserInfoVo
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?,
/**
* User information object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see UserInfoVo
*/
@Schema(description = "用户资料")
val userInfo: UserInfoVo?,
/**
* List of RoleVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see RoleVo
*/
@Schema(description = "角色列表")
val roles: List<RoleVo>?,
/**
* List of GroupVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see GroupVo
*/
@Schema(description = "用户组列表")
val groups: List<GroupVo>?
)

View File

@@ -0,0 +1,47 @@
package top.fatweb.oxygen.api.vo.permission.base
import io.swagger.v3.oas.annotations.media.Schema
/**
* Function value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "功能返回参数")
data class FuncVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "功能名", example = "AddButton")
val name: String?,
/**
* Parent ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "父 ID")
val parentId: Long?,
/**
* Menu ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "菜单 ID")
val menuId: Long?
)

View File

@@ -0,0 +1,62 @@
package top.fatweb.oxygen.api.vo.permission.base
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import java.time.LocalDateTime
/**
* Group value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户组返回参数")
data class GroupVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户组名", example = "Group")
val name: String?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "启用", example = "true")
val enable: Boolean?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?
)

View File

@@ -0,0 +1,56 @@
package top.fatweb.oxygen.api.vo.permission.base
import io.swagger.v3.oas.annotations.media.Schema
/**
* Menu value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "菜单返回参数")
data class MenuVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "菜单名", example = "System")
val name: String?,
/**
* URL
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "URL", example = "/system")
val url: String?,
/**
* Parent ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "父 ID")
val parentId: Long?,
/**
* Module ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "模块 ID")
val moduleId: Long?
)

View File

@@ -0,0 +1,29 @@
package top.fatweb.oxygen.api.vo.permission.base
import io.swagger.v3.oas.annotations.media.Schema
/**
* Module value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "模块返回参数")
data class ModuleVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "模块名", example = "系统")
val name: String?
)

View File

@@ -0,0 +1,47 @@
package top.fatweb.oxygen.api.vo.permission.base
import io.swagger.v3.oas.annotations.media.Schema
/**
* Operation value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作返回参数")
data class OperationVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作名", example = "Add User")
val name: String?,
/**
* Code
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作编码", example = "system:user:add")
val code: String?,
/**
* Function ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "功能 ID")
val funcId: Long?
)

View File

@@ -0,0 +1,62 @@
package top.fatweb.oxygen.api.vo.permission.base
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import java.time.LocalDateTime
/**
* Role value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "角色返回参数")
data class RoleVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "角色名", example = "Role")
val name: String?,
/**
* Enable
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "启用", example = "true")
val enable: Boolean?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?
)

View File

@@ -0,0 +1,81 @@
package top.fatweb.oxygen.api.vo.permission.base
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import java.time.LocalDateTime
/**
* User information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户资料返回参数")
data class UserInfoVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* User ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户ID")
@JsonSerialize(using = ToStringSerializer::class)
val userId: Long?,
/**
* Nickname
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "昵称", example = "User")
val nickname: String?,
/**
* Avatar base64
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "头像")
val avatar: String?,
/**
* Email
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "邮箱", example = "user@mail.com")
val email: String?,
/**
* Create time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "创建时间", example = "1900-01-01T00:00:00.000Z")
val createTime: LocalDateTime?,
/**
* Update time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "修改时间", example = "1900-01-01T00:00:00.000Z")
val updateTime: LocalDateTime?
)

View File

@@ -0,0 +1,63 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.system.ActiveInfoVo.HistoryVo
import java.time.LocalDate
/**
* Active information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户活跃信息返回参数")
data class ActiveInfoVo(
/**
* Register user number history
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "注册用户数量历史")
val registerHistory: List<HistoryVo>,
/**
* Login user number history
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see HistoryVo
*/
@Schema(description = "登录用户数量历史")
val loginHistory: List<HistoryVo>,
/**
* Verify user number history
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "验证用户数量历史")
val verifyHistory: List<HistoryVo>
) {
data class HistoryVo(
/**
* Time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDate
*/
@Schema(description = "记录时间", example = "1900-01-01")
val time: LocalDate,
/**
* Count
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "数量")
val count: Int
)
}

View File

@@ -0,0 +1,48 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
/**
* Base settings value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "基础设置返回参数")
data class BaseSettingsVo(
/**
* Application name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "应用名称")
val appName: String?,
/**
* Application URL
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "应用 URL")
val appUrl: String?,
/**
* Verify URL
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "验证邮箱 URL")
val verifyUrl: String?,
/**
* Retrieve URL
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "找回密码 URL")
val retrieveUrl: String?
)

View File

@@ -0,0 +1,124 @@
package top.fatweb.oxygen.api.vo.system
import com.fasterxml.jackson.annotation.JsonInclude
import io.swagger.v3.oas.annotations.media.Schema
/**
* CPU information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "CPU 信息返回参数")
@JsonInclude(JsonInclude.Include.NON_EMPTY)
data class CpuInfoVo(
/**
* Show the percentage of CPU utilization
* that occurred while executing at the user
* level (application).
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "user")
val user: Long,
/**
* Show the percentage of CPU utilization
* that occurred while executing at the user
* level with nice priority.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "nice")
val nice: Long,
/**
* Show the percentage of CPU utilization that
* occurred while executing at the system level
* (kernel). Note that this does not include time
* spent servicing hardware and software
* interrupts.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "system")
val system: Long,
/**
* Show the percentage of time that the
* CPU or CPUs were idle and the system did
* not have an outstanding disk I/O request.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "idle")
val idle: Long,
/**
* Show the percentage of time that the
* CPU or CPUs were idle during which the
* system had an outstanding disk I/O
* request.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "iowait")
val iowait: Long,
/**
* Show the percentage of time spent by
* the CPU or CPUs to service hardware
* interrupts.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "irq")
val irq: Long,
/**
* Show the percentage of time spent by
* the CPU or CPUs to service software
* interrupts.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "softirq")
val softirq: Long,
/**
* Show the percentage of time spent in
* involuntary wait by the virtual CPU or CPUs
* while the hypervisor was servicing another
* virtual processor.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "steal")
val steal: Long,
/**
* total = user + nice + system + idle + iowait + irq + softirq + steal
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "total")
val total: Long,
/**
* List of CPU processors information
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "处理器列表")
val processors: List<CpuInfoVo>? = null
)

View File

@@ -0,0 +1,43 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
/**
* File storage information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "文件存储信息返回参数")
data class FileStoreInfoVo(
/**
* Mount point of the File System. The
* directory users will normally use to
* interface with the file store.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "挂载点")
val mount: String,
/**
* Total space/capacity of the drive.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总容量")
val total: Long,
/**
* Free space on the drive. This space is
* unallocated but may require elevated
* permissions to write.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "空闲容量")
val free: Long
)

View File

@@ -0,0 +1,104 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
/**
* Hardware information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "硬件信息返回参数")
data class HardwareInfoVo(
/**
* Name of CPU
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "CPU")
val cpu: String,
/**
* Arch of CPU
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "架构")
val arch: String,
/**
* Is CPU 64bit
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否为64位")
val is64Bit: Boolean,
/**
* Number of packages/sockets in the system. A
* single package may contain multiple cores.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "物理 CPU")
val cpuPhysicalPackageCount: Int,
/**
* Number of physical CPUs/cores available for
* processing.
*
* On some operating systems with variable numbers
* of physical processors available to the OS, may
* return a max value.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "物理核心")
val cpuPhysicalProcessorCount: Int,
/**
* Number of logical CPUs available for processing.
* This value may be higher than physical CPUs if
* hyperthreading is enabled.
*
* On some operating systems with variable numbers
* of logical processors, may return a max value.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "逻辑核心")
val cpuLogicalProcessorCount: Int,
/**
* Processor's microarchitecture, if known.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "微架构")
val microarchitecture: String,
/**
* Memory information overview
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "内存")
val memories: String,
/**
* Disk information overview
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "存储")
val disks: String
)

View File

@@ -0,0 +1,76 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.settings.MailSecurityType
/**
* Mail settings value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "邮件设置返回参数")
data class MailSettingsVo(
/**
* Host
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "SMTP 服务器")
val host: String?,
/**
* Port
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "端口")
val port: Int?,
/**
* Security type
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "安全类型")
val securityType: MailSecurityType?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户名")
val username: String?,
/**
* Password
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "密码")
val password: String?,
/**
* Sender
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "发送者")
val from: String?,
/**
* Sender name
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "发送者名称")
val fromName: String?
)

View File

@@ -0,0 +1,54 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.vo.system.OnlineInfoVo.HistoryVo
import java.time.LocalDateTime
/**
* Online information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "在线信息返回参数")
data class OnlineInfoVo(
/**
* Number of user currently online
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "当前在线用户数量")
val current: Long,
/**
* Online number history
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see HistoryVo
*/
@Schema(description = "历史记录")
val history: List<HistoryVo>
) {
data class HistoryVo(
/**
* Time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "记录时间")
val time: LocalDateTime,
/**
* Record
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "记录")
val record: String
)
}

View File

@@ -0,0 +1,23 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
/**
* System settings value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "系统设置返回参数")
data class SettingsVo(
/**
* MailSettingVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see MailSettingsVo
*/
@Schema(description = "邮件设置")
val mail: MailSettingsVo?
)

View File

@@ -0,0 +1,139 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
import java.time.LocalDateTime
/**
* Software information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "软甲信息返回参数")
data class SoftwareInfoVo(
/**
* Operating system
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作系统")
val os: String,
/**
* Bitness (32 or 64) of the operating system.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "位数")
val bitness: Int,
/**
* Version of Java
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 版本")
val javaVersion: String,
/**
* Version date of Java
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 版本日期")
val javaVersionDate: String,
/**
* Vendor of Java
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 供应商")
val javaVendor: String,
/**
* Name of Java runtime
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 运行时")
val javaRuntime: String,
/**
* Version of Java runtime
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 运行时版本")
val javaRuntimeVersion: String,
/**
* Name of Java virtual machine
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机")
val jvm: String,
/**
* Version of Java virtual machine
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机版本")
val jvmVersion: String,
/**
* Version of Java Virtual machine
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机信息")
val jvmInfo: String,
/**
* Vendor of Java Virtual machine
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机供应商")
val jvmVendor: String,
/**
* Version of Java class
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 字节文件版本")
val javaClassVersion: String,
/**
* Boot time of operating system
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作系统启动时间")
val osBootTime: LocalDateTime,
/**
* Startup time of server
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "服务器启动时间")
val serverStartupTime: LocalDateTime
)

View File

@@ -0,0 +1,117 @@
package top.fatweb.oxygen.api.vo.system
import io.swagger.v3.oas.annotations.media.Schema
/**
* Storage information value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "存储信息返回参数")
data class StorageInfoVo(
/**
* The amount of actual physical memory.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总内存容量")
val memoryTotal: Long,
/**
* The amount of physical memory currently
* available。
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "空闲内存容量")
val memoryFree: Long,
/**
* The maximum memory that can be committed by the
* system without extending the paging file(s). Also called the
* Commit Limit. If the paging/swap file can be extended, this
* is a soft limit. This is generally equal to the sum of the sizes
* of physical memory and paging/swap file(s).
*
* On Linux, represents the total amount of memory currently
* available to be allocated on the system based on the
* overcommit ratio, identified as CommitLimit. This may be
* higher or lower than the total size of physical and swap
* memory depending on system configuration.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总虚拟内存容量")
val virtualMemoryMax: Long,
/**
* The memory currently committed by the system, in
* bytes. Also called the Commit Total. This is generally
* equal to the sum of the bytes used of physical
* memory and paging/swap file(s).
*
* On Windows, committing pages changes this value
* immediately; however, the physical memory is not
* charged until the pages are accessed, so this
* value may exceed the sum of used physical and
* paging/swap file memory.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "已用虚拟内存容量")
val virtualMemoryInUse: Long,
/**
* The current size of the paging/swap
* file(s). If the paging/swap file can be
* extended, this is a soft limit.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "总交换区容量")
val swapTotal: Long,
/**
* The current memory committed to the
* paging/swap file(s).
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "可用交换区容量")
val swapUsed: Long,
/**
* Total amount of memory in the Java virtual machine.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机总内存容量")
val jvmTotal: Long,
/**
* Amount of free memory in the Java Virtual Machine.
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "Java 虚拟机空闲内存容量")
val jvmFree: Long,
/**
* List of FileStoreInfoVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see FileStoreInfoVo
*/
@Schema(description = "文件存储信息列表")
val fileStores: List<FileStoreInfoVo>
)

View File

@@ -0,0 +1,164 @@
package top.fatweb.oxygen.api.vo.system
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
import io.swagger.v3.oas.annotations.media.Schema
import top.fatweb.oxygen.api.entity.system.SysLog
import java.time.LocalDateTime
/**
* System log value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "获取系统日志返回参数")
data class SysLogVo(
/**
* ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@JsonSerialize(using = ToStringSerializer::class)
val id: Long?,
/**
* Log type
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "日志类型")
val logType: SysLog.LogType?,
/**
* Operate user ID
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作用户 ID")
@JsonSerialize(using = ToStringSerializer::class)
val operateUserId: Long?,
/**
* Operate time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "操作时间")
val operateTime: LocalDateTime?,
/**
* Request URI
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "请求 Uri")
val requestUri: String?,
/**
* Request Method
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "请求方式")
val requestMethod: String?,
/**
* Request parameters
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "请求参数")
val requestParams: String?,
/**
* Request IP
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "请求 IP")
val requestIp: String?,
/**
* Request server address
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "请求服务器地址")
val requestServerAddress: String?,
/**
* Is exception
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "是否异常")
val exception: Boolean?,
/**
* Exception information
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "异常信息")
val exceptionInfo: String?,
/**
* Start time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "开始时间")
val startTime: LocalDateTime?,
/**
* End time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see LocalDateTime
*/
@Schema(description = "结束时间")
val endTime: LocalDateTime?,
/**
* Execute time
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "执行时间")
val executeTime: Long?,
/**
* User agent
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "用户代理")
val userAgent: String?,
/**
* Operate username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "操作用户名")
val operateUsername: String?
)