FatttSnake/oxygen-api
1
0
Fork 0
Code Pull Requests Activity

Add kdoc

Browse Source
This commit is contained in:
Fat Snake
2023-12-04 18:05:57 +08:00
parent 902fcef9b2
commit 00964a15f3
146 changed files with 3486 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/main/kotlin/top/fatweb/api/vo/PageVo.kt
View File

@@ -10,18 +10,48 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@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>
)

6
src/main/kotlin/top/fatweb/api/vo/api/v1/avatar/AvatarBase64Vo.kt
View File

@@ -10,6 +10,12 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@Schema(description = "头像 Base64 返回参数")
data class AvatarBase64Vo(
/**
* Base64
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(description = "base64")
val base64: String?
)

39
src/main/kotlin/top/fatweb/api/vo/permission/GroupWithRoleVo.kt
View File

@@ -13,21 +13,60 @@ import java.time.LocalDateTime
* @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>?
)

19
src/main/kotlin/top/fatweb/api/vo/permission/LoginVo.kt
View File

@@ -11,16 +11,35 @@ import java.time.LocalDateTime
*/
@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,
/**
* 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"

28
src/main/kotlin/top/fatweb/api/vo/permission/PowerSetVo.kt
View File

@@ -14,15 +14,43 @@ import top.fatweb.api.vo.permission.base.OperationVo
*/
@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>?
)

60
src/main/kotlin/top/fatweb/api/vo/permission/RoleWithPowerVo.kt
View File

@@ -17,30 +17,90 @@ import java.time.LocalDateTime
*/
@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>?
)

6
src/main/kotlin/top/fatweb/api/vo/permission/TokenVo.kt
View File

@@ -10,6 +10,12 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@Schema(description = "Token 返回参数")
data class TokenVo(
/**
* Token
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
@Schema(
description = "Token",
example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkYTllYjFkYmVmZDQ0OWRkOThlOGNjNzZlNzZkMDgyNSIsInN1YiI6IjE3MDk5ODYwNTg2Nzk5NzU5MzgiLCJpc3MiOiJGYXRXZWIiLCJpYXQiOjE2OTY1MjgxMTcsImV4cCI6MTY5NjUzNTMxN30.U2ZsyrGk7NbsP-DJfdz9xgWSfect5r2iKQnlEsscAA8"

85
src/main/kotlin/top/fatweb/api/vo/permission/UserWithInfoVo.kt
View File

@@ -14,42 +14,127 @@ import java.time.LocalDateTime
*/
@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?,
/**
* 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?
)

105
src/main/kotlin/top/fatweb/api/vo/permission/UserWithPasswordRoleInfoVo.kt
View File

@@ -16,51 +16,156 @@ import java.time.LocalDateTime
*/
@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?,
/**
* 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>?
)

110
src/main/kotlin/top/fatweb/api/vo/permission/UserWithPowerInfoVo.kt
View File

@@ -14,54 +14,164 @@ import java.time.LocalDateTime
*/
@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?,
/**
* 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>?
)

101
src/main/kotlin/top/fatweb/api/vo/permission/UserWithRoleInfoVo.kt
View File

@@ -16,48 +16,149 @@ import java.time.LocalDateTime
*/
@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?,
/**
* 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>?
)

24
src/main/kotlin/top/fatweb/api/vo/permission/base/FuncVo.kt
View File

@@ -10,14 +10,38 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@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?
)

32
src/main/kotlin/top/fatweb/api/vo/permission/base/GroupVo.kt
View File

@@ -13,18 +13,50 @@ import java.time.LocalDateTime
*/
@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?
)

30
src/main/kotlin/top/fatweb/api/vo/permission/base/MenuVo.kt
View File

@@ -10,17 +10,47 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@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?
)

12
src/main/kotlin/top/fatweb/api/vo/permission/base/ModuleVo.kt
View File

@@ -10,8 +10,20 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@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?
)

24
src/main/kotlin/top/fatweb/api/vo/permission/base/OperationVo.kt
View File

@@ -10,14 +10,38 @@ import io.swagger.v3.oas.annotations.media.Schema
*/
@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?
)

32
src/main/kotlin/top/fatweb/api/vo/permission/base/RoleVo.kt
View File

@@ -13,18 +13,50 @@ import java.time.LocalDateTime
*/
@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?
)

44
src/main/kotlin/top/fatweb/api/vo/permission/base/UserInfoVo.kt
View File

@@ -13,25 +13,69 @@ import java.time.LocalDateTime
*/
@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@fatweb.top")
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?
)

53
src/main/kotlin/top/fatweb/api/vo/system/SettingsVo.kt
View File

@@ -1,13 +1,66 @@
package top.fatweb.api.vo.system
/**
* System settings value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
data class SettingsVo(
/**
* MailSettingVo object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
* @see MailSettingsVo
*/
val mail: MailSettingsVo?
) {
/**
* Mail settings value object
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
data class MailSettingsVo(
/**
* Host
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val host: String?,
/**
* Port
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val port: Int?,
/**
* Username
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val username: String?,
/**
* Password
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val password: String?,
/**
* Sender
*
* @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0
*/
val from: String?
)
}

99
src/main/kotlin/top/fatweb/api/vo/system/SysLogVo.kt
View File

@@ -13,52 +13,151 @@ import java.time.LocalDateTime
*/
@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: String?,
/**
* 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?
)