guke
a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
# GET /admin/api/feedbacks — 反馈工单列表(offset 分页 + 筛选/排序)
|
||
|
||
> 所属:Admin·反馈 组（前缀 `/admin/api/feedbacks`） | 鉴权:Bearer admin_token（角色:任意已登录管理员,无 `require_role`,仅 `get_current_admin`） | [← 返回 API 索引](../../README.md)
|
||
|
||
## 入参（query）
|
||
| 字段 | 类型 | 必填 | 默认 | 说明 |
|
||
|---|---|---|---|---|
|
||
| `status` | string | ❌ | null | 反馈状态,精确匹配:`new`(待处理) / `handled`(已处理);传空/不传则不筛 |
|
||
| `user_id` | int | ❌ | null | 按提交用户 id 精确筛 |
|
||
| `content` | string | ❌ | null | 反馈内容模糊匹配(ilike,≤100 字) |
|
||
| `created_from` | datetime | ❌ | null | 提交时间 ≥(ISO,统一按 UTC 比较) |
|
||
| `created_to` | datetime | ❌ | null | 提交时间 ≤(ISO,统一按 UTC 比较) |
|
||
| `sort_by` | string | ❌ | `id` | 排序列:`id` / `created_at` |
|
||
| `sort_order` | string | ❌ | `desc` | `asc` / `desc` |
|
||
| `limit` | int | ❌ | 20 | 1–100 |
|
||
| `cursor` | int | ❌ | null | 上一页 next_cursor(**offset 分页**,cursor=offset) |
|
||
|
||
## 出参
|
||
响应 `200`:`{ items: FeedbackOut[], next_cursor: int|null }`(`next_cursor=null` 表示末页)
|
||
|
||
**FeedbackOut**
|
||
| 字段 | 类型 | 说明 |
|
||
|---|---|---|
|
||
| `id` | int | 反馈 id |
|
||
| `user_id` | int | 提交用户 id |
|
||
| `content` | string | 反馈内容 |
|
||
| `contact` | string | 联系方式(微信/QQ/手机,便于回访) |
|
||
| `images` | string[] \| null | 截图相对路径列表(如 `["/media/feedback/u1_ab12.jpg"]`),无图为 null |
|
||
| `status` | string | 反馈状态:`new`(待处理) / `handled`(已处理) |
|
||
| `created_at` | datetime | 提交时间(UTC) |
|
||
|
||
## 错误码
|
||
- `401` 未带/无效/过期 admin token、管理员被禁用(头带 `WWW-Authenticate: Bearer`)
|
||
- `422` `limit` 超出 1–100 范围 / `sort_by`·`sort_order` 不在允许集 / 字段类型不合法
|
||
|
||
## 说明
|
||
- **offset 分页**(同 [admin-users-list](./admin-users-list.md)):`cursor` 即 offset,传上一页返回的 `next_cursor`;`next_cursor=null` 即末页。改用 offset 是为了在任意列排序下游标语义统一,代价是翻页期间数据变动可能错位一条(admin 低频可接受)。
|
||
- 排序:`sort_by`(id/created_at)× `sort_order`(asc/desc),恒以 `id` 同向兜底次序。
|
||
- `status` / `user_id` 精确匹配、`content` 模糊、`created_from`/`created_to` 时间范围,均可叠加。
|
||
- 关联表 [feedback](../database/feedback.md);截图为相对路径,经 `GET /media/feedback/<file>` 静态读。
|