Files
TimiServerAPI/http/object/common.md
T
2026-07-31 01:03:53 +08:00

78 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 通用对象说明
## TimiResponse<T>
| 字段 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应码,`20000` 为成功 |
| msg | String | 响应消息 |
| data | T | 业务数据体,具体结构由接口返回对象决定 |
## Page<T>
| 字段 | 类型 | 说明 |
|---|---|---|
| index | int | 页码下标,从 `0` 开始 |
| size | long | 每页数量 |
| equalsExample | T | 精确匹配示例对象,非空字段参与精确查询 |
| likesExample | T | 模糊匹配示例对象,非空字段参与模糊查询 |
| equalsLogic | Logic | 精确匹配字段之间的连接逻辑,默认 `AND` |
| likesLogic | Logic | 模糊匹配字段之间的连接逻辑,默认 `OR` |
| orderMap | LinkedHashMap<String, OrderType> | 排序字段映射,键通常为字段名,值为排序方向 |
## PageResult<T>
| 字段 | 类型 | 说明 |
|---|---|---|
| total | long | 总数据量 |
| pages | int | 总页数 |
| list | List<T> | 当前页数据列表 |
## UUIDEntity
| 字段 | 类型 | 说明 |
|---|---|---|
| id | String | 主键 IDUUID 字符串 |
| createdAt | Long | 创建时间,Unix 时间戳毫秒 |
| updatedAt | Long | 更新时间,Unix 时间戳毫秒 |
| deletedAt | Long | 删除时间,Unix 时间戳毫秒,未删除时通常为空 |
## Multilingual
| 字段 | 类型 | 说明 |
|---|---|---|
| id | String | 多语言 ID |
| zhCN | String | 简体中文文本 |
| zhTW | String | 繁体中文文本 |
| enUS | String | 英文文本 |
| ruRU | String | 俄文文本 |
| jaJP | String | 日文文本 |
| deDE | String | 德文文本 |
| koKR | String | 韩文文本 |
| lastAccessAt | Long | 最后访问时间,Unix 时间戳毫秒 |
| createdAt | Long | 创建时间,Unix 时间戳毫秒 |
| updatedAt | Long | 更新时间,Unix 时间戳毫秒 |
| deletedAt | Long | 删除时间,Unix 时间戳毫秒,未删除时通常为空 |
## Logic
| 枚举 | 说明 |
|---|---|
| AND | 多个条件同时满足 |
| OR | 多个条件满足其一 |
## OrderType
| 枚举 | 说明 |
|---|---|
| ASC | 升序 |
| DESC | 降序 |
## ImageType
| 枚举 | 说明 |
|---|---|
| AUTO | 双线性 |
| SMOOTH | 模糊 |
| PIXELATED | 像素 |