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>
)