refactor all

http/object/common.md

@@ -0,0 +1,77 @@
+# 通用对象说明
+
+## 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 | 主键 ID，UUID 字符串 |
+| 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 | 像素 |

http/object/permission.md

@@ -0,0 +1,31 @@
+# 权限对象说明
+
+## Permission
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| id | String | 权限 ID |
+| createdAt | Long | 创建时间，Unix 时间戳毫秒 |
+| updatedAt | Long | 更新时间，Unix 时间戳毫秒 |
+| deletedAt | Long | 删除时间，Unix 时间戳毫秒 |
+| code | String | 权限代码，需与数据库 `permission.code` 保持一致 |
+| nameLangId | String | 权限名称的多语言键 |
+| description | String | 权限说明 |
+| name | String | 当前语言下的权限名称 |
+
+## BatchCreateReq
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| prefixCode | String | 权限代码前缀，例如 `ROLE` |
+| prefixName | String | 权限名称前缀，例如 `角色` |
+| types | Type[] | 需要批量生成的权限类型列表，详见 `BatchCreateType` |
+
+## BatchCreateType
+
+| 枚举 | 说明 |
+|---|---|
+| CREATE | 创建权限 |
+| READ | 读取权限 |
+| UPDATE | 更新权限 |
+| DELETE | 删除权限 |

http/object/role.md

@@ -0,0 +1,34 @@
+# 角色对象说明
+
+## Role
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| id | String | 角色 ID |
+| createdAt | Long | 创建时间，Unix 时间戳毫秒 |
+| updatedAt | Long | 更新时间，Unix 时间戳毫秒 |
+| deletedAt | Long | 删除时间，Unix 时间戳毫秒 |
+| code | String | 角色代码，常见值见 `RoleCode` |
+| nameLangId | String | 角色名称的多语言键 |
+| description | String | 角色说明 |
+| name | String | 当前语言下的角色名称 |
+| permissionList | List<Permission> | 角色自身直接绑定的权限列表 |
+| allPermissionList | List<Permission> | 角色全部权限列表，包含继承自子角色的权限 |
+| childRoleList | List<Role> | 子角色列表 |
+| permissionIdList | Set<String> | 权限 ID 列表，创建或更新角色时使用 |
+| childRoleIdList | Set<String> | 子角色 ID 列表，创建或更新角色时使用 |
+
+## UserRoleAuthorizeReq
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| userId | String | 目标用户 ID |
+| roleIdList | List<String> | 需要授权的角色 ID 列表 |
+| roleCodeList | List<String> | 需要授权的角色代码列表 |
+
+## RoleCode
+
+| 枚举 | 说明 |
+|---|---|
+| SYSTEM | 系统 |
+| ADMIN | 管理员 |

http/object/user.md

@@ -0,0 +1,73 @@
+# 用户对象说明
+
+## User
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| id | String | 用户 ID |
+| createdAt | Long | 创建时间，Unix 时间戳毫秒 |
+| updatedAt | Long | 更新时间，Unix 时间戳毫秒 |
+| deletedAt | Long | 删除时间，Unix 时间戳毫秒 |
+| name | String | 登录名，系统内唯一 |
+| nick | String | 用户昵称 |
+| password | String | 明文密码，请求时填写，响应通常不返回 |
+| email | String | 邮箱地址 |
+| emailVerifyAt | Long | 邮箱验证时间，Unix 时间戳毫秒 |
+| phoneNo | String | 手机号，11 位大陆手机号 |
+| phoneNoVerifyAt | Long | 手机号验证时间，Unix 时间戳毫秒 |
+| wrapperType | ImageType | 背景图渲染算法，详见 `ImageType` |
+| avatarType | ImageType | 头像渲染算法，详见 `ImageType` |
+| exp | Integer | 经验值 |
+| sex | Integer | 性别，当前代码未定义枚举说明 |
+| birthdate | Long | 出生日期，Unix 时间戳毫秒 |
+| qq | String | QQ 号 |
+| description | String | 个人说明 |
+| lastLoginIP | String | 上次登录 IP |
+| lastLoginAt | Long | 上次登录时间，Unix 时间戳毫秒 |
+| unmuteAt | Long | 解除禁言时间，Unix 时间戳毫秒 |
+| unbanAt | Long | 解除封禁时间，Unix 时间戳毫秒 |
+| roleList | List<String> | 角色代码列表 |
+| permissionList | List<String> | 权限代码列表 |
+| attachmentList | List<Attachment> | 附件列表 |
+| settingList | List<Setting> | 设置列表 |
+
+## LoginRequest
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| user | String | 用户标识，可能是 UID、邮箱或用户名 |
+| password | String | 明文密码 |
+
+## LoginResponse
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| token | String | 登录令牌 |
+| expireAt | Long | 令牌过期时间，Unix 时间戳毫秒 |
+| user | User | 当前登录用户 |
+
+## UpdatePasswordRequest
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| oldValue | String | 原密码 |
+| newValue | String | 新密码 |
+
+## PhoneVerifyCodeSendRequest
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| phoneNo | String | 手机号，必须为 11 位大陆手机号 |
+
+## PhoneVerifyRequest
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| phoneNo | String | 手机号，必须为 11 位大陆手机号 |
+| verifyCode | String | 6 位数字验证码 |
+
+## CancelRequest
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| password | String | 当前密码，用于确认注销 |