@ (#111)

docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
2026-07-03 15:00:37 +08:00
parent ee132aa93b
commit a563c1ca4b
102 changed files with 2418 additions and 217 deletions
@@ -0,0 +1,40 @@
+# POST /admin/api/auth/login — 管理员登录
+
+> 所属:Admin·Auth 组（前缀 `/admin/api/auth`） | 鉴权:无 | [← 返回 API 索引](../../README.md)
+
+## 入参
+**application/json**:
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `username` | string | ✓ | 管理员账号,1–64 字 |
+| `password` | string | ✓ | 密码,1–128 字 |
+
+## 出参
+响应 `200`:`AdminLoginResponse`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `access_token` | string | admin JWT(独立 `ADMIN_JWT_SECRET`、payload `typ=admin`、默认 12h、无 refresh) |
+| `token_type` | string | 固定 `Bearer` |
+| `expires_in` | int | access_token 剩余秒数(过期需重新登录) |
+| `admin` | AdminOut | 当前管理员信息,字段见下 |
+
+**AdminOut**
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | 管理员 id |
+| `username` | string | 账号 |
+| `role` | string | 角色:`super_admin` / `finance` / `operator` |
+| `status` | string | 状态:`active` / `disabled` |
+| `created_at` | datetime | 创建时间(UTC) |
+| `last_login_at` | datetime \| null | 上次登录时间,从未登录为 null |
+
+## 错误码
+- `401` 用户名或密码错误(用户名不存在与密码错误统一同文案,防账号枚举)
+- `403` 账号已禁用(`status != active`)
+- `422` 缺 `username` 或 `password` / 长度超限
+- `429` 同 IP 每分钟登录超过 10 次(限流防爆破)
+
+## 说明
+- 登录成功后回写 `last_login_at` 为当前时间。
+- 后续所有 admin 接口须带 `Authorization: Bearer <access_token>`;admin token 与 App 用户 token 完全隔离。
@@ -0,0 +1,24 @@
+# GET /admin/api/auth/me — 当前管理员
+
+> 所属:Admin·Auth 组（前缀 `/admin/api/auth`） | 鉴权:Bearer admin_token（角色:任意已登录 admin） | [← 返回 API 索引](../../README.md)
+
+## 入参
+无（身份取自 Header token）
+
+## 出参
+响应 `200`:`AdminOut`
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | 管理员 id |
+| `username` | string | 账号 |
+| `role` | string | 角色:`super_admin` / `finance` / `operator` |
+| `status` | string | 状态:`active` / `disabled` |
+| `created_at` | datetime | 创建时间(UTC) |
+| `last_login_at` | datetime \| null | 上次登录时间,从未登录为 null |
+
+## 错误码
+- `401` 未带 admin token / token 无效或过期 / `typ` 非 admin / 管理员不存在或被禁用(响应头带 `WWW-Authenticate: Bearer`)
+
+## 说明
+无