签入版本

This commit is contained in:
2026-10-08 17:50:29 +08:00
parent 809750b47e
commit e213a9b31d
444 changed files with 39366 additions and 37533 deletions
@@ -1,7 +1,7 @@
# 12.2 分页查询规范
:::tip 概述
所有分页接口遵循统一的参数命名和返回结构,确保前后端一致性。
所有分页接口遵循统一的参数命名和返回结构,确保前后端一致性。详细机制见 [8.3 分页查询规范](/zh/api-spec/pagination.html)。
:::
## 请求参数
@@ -9,11 +9,11 @@
| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `pageNo` | number | 1 | 页码(最小为 1) |
| `pageSize` | number | 20 | 每页条数(1~100) |
| `pageSize` | number | 20 | 每页条数(1~100,超出自动限制) |
| `orderField` | string | - | 排序字段(camelCase,如 `createTime`) |
| `orderType` | string | `desc` | 排序方向(`asc` / `desc`) |
| `fields` | string | - | 返回字段(逗号分隔,如 `id,username,status`) |
| 其他参数 | - | - | 按 Logic 中 pageLikeFields / pageEqFields 自动匹配 |
| 其他参数 | - | - | 按 Service 中 pageLikeFields / pageEqFields 自动匹配 |
## 请求示例
@@ -62,4 +62,8 @@ GET /api/example/page?pageNo=1&pageSize=10&fields=id,name,status
| 前端传参 | 后端处理 | SQL |
|---------|---------|-----|
| `orderField=createTime&orderType=desc` | 转为 `create_time` | `ORDER BY create_time DESC` |
| 不传 | 使用 Logic 默认排序 | 按 `pageOrderBy` 配置 |
| 不传 | 使用 Service 默认排序 | 按 `pageOrderBy` 配置 |
:::warning 排序白名单
`orderField` 只在 **`pageOrderBy` 默认字段 ∪ `orderFieldAllow`** 的并集内生效,不在白名单内的字段直接忽略(防 SQL 注入)。开放新排序字段请配置 `orderFieldAllow`。
:::