Add doc
This commit is contained in:
@@ -2,6 +2,12 @@ package top.fatweb.api.vo
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Page value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "分页返回参数")
|
||||
data class PageVo<T>(
|
||||
@Schema(description = "总数量", example = "100")
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Element value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "页面元素返回参数")
|
||||
data class ElementVo(
|
||||
val id: Long?,
|
||||
|
||||
@@ -5,6 +5,12 @@ 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
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "用户组返回参数")
|
||||
data class GroupVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -5,6 +5,12 @@ import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* Group with role value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
data class GroupWithRoleVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
val id: Long?,
|
||||
|
||||
@@ -3,6 +3,12 @@ package top.fatweb.api.vo.permission
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* Login value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "登录返回参数")
|
||||
data class LoginVo(
|
||||
@Schema(
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Menu value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "菜单返回参数")
|
||||
data class MenuVo(
|
||||
val id: Long?,
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Module value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "模块返回参数")
|
||||
data class ModuleVo(
|
||||
val id: Long?,
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Operation value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "功能返回参数")
|
||||
data class OperationVo(
|
||||
val id: Long?,
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Set of power value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "权限集合返回参数")
|
||||
data class PowerSetVo(
|
||||
@Schema(description = "模块列表")
|
||||
|
||||
@@ -5,6 +5,12 @@ 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
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "角色返回参数")
|
||||
data class RoleVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -5,6 +5,12 @@ import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* Role with power value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "角色返回参数")
|
||||
data class RoleWithPowerVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -2,6 +2,12 @@ package top.fatweb.api.vo.permission
|
||||
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
|
||||
/**
|
||||
* Token value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "Token 返回参数")
|
||||
data class TokenVo(
|
||||
@Schema(
|
||||
|
||||
@@ -5,6 +5,12 @@ 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
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "用户资料返回参数")
|
||||
data class UserInfoVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -5,6 +5,12 @@ import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* User with power information value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "用户权限信息返回参数")
|
||||
data class UserWithPowerInfoVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -5,6 +5,12 @@ import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* User with role information value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "用户角色信息返回参数")
|
||||
data class UserWithRoleInfoVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
|
||||
@@ -5,8 +5,14 @@ import com.fasterxml.jackson.databind.ser.std.ToStringSerializer
|
||||
import io.swagger.v3.oas.annotations.media.Schema
|
||||
import java.time.LocalDateTime
|
||||
|
||||
/**
|
||||
* System log value object
|
||||
*
|
||||
* @author FatttSnake
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Schema(description = "获取系统日志返回参数")
|
||||
class SysLogGetVo(
|
||||
class SysLogVo(
|
||||
@JsonSerialize(using = ToStringSerializer::class)
|
||||
val id: Long?,
|
||||
|
||||
Reference in New Issue
Block a user