@ (#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,33 @@
+# POST /admin/api/admins — 创建管理员
+
+> 所属:Admin·Accounts 组（前缀 `/admin/api/admins`） | 鉴权:Bearer admin_token（角色:super_admin） | [← 返回 API 索引](../../README.md)
+
+## 入参
+**application/json**:
+| 字段 | 类型 | 必填 | 默认 | 说明 |
+|---|---|---|---|---|
+| `username` | string | ✓ | — | 账号,3–64 字 |
+| `password` | string | ✓ | — | 初始密码,8–72 字(bcrypt ≤72 字节) |
+| `role` | string | ✗ | `operator` | 角色,枚举:`super_admin` / `finance` / `operator` |
+
+## 出参
+响应 `200`:`AdminOut`（新建的管理员)
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | 管理员 id |
+| `username` | string | 账号 |
+| `role` | string | 角色 |
+| `status` | string | 状态(新建默认 `active`) |
+| `created_at` | datetime | 创建时间(UTC) |
+| `last_login_at` | datetime \| null | 上次登录时间(新建为 null) |
+
+## 错误码
+- `401` 未带 admin token / token 无效或过期 / 管理员被禁用
+- `403` 角色不足(仅 super_admin)
+- `409` 用户名已存在
+- `422` 缺字段 / `username` 长度不在 3–64 / `password` 长度不在 8–72 / `role` 非法枚举
+
+## 说明
+- 创建成功后写一条审计:`action=admin.create`、`target_type=admin`、`target_id=新管理员 id`、`detail={username, role}`。见 [admin_audit_log](../database/admin_audit_log.md)。
+- 数据表见 [admin_user](../database/admin_user.md)。
@@ -0,0 +1,39 @@
+# PATCH /admin/api/admins/{admin_id} — 改角色/启停/重置密码
+
+> 所属:Admin·Accounts 组（前缀 `/admin/api/admins`） | 鉴权:Bearer admin_token（角色:super_admin） | [← 返回 API 索引](../../README.md)
+
+## 入参
+**路径参数**:
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `admin_id` | int | ✓ | 目标管理员 id |
+
+**application/json**(三字段都可选,只改传了的;至少传一个):
+| 字段 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| `role` | string | ✗ | 改角色,枚举:`super_admin` / `finance` / `operator` |
+| `status` | string | ✗ | 启停,枚举:`active`(启用)/ `disabled`(禁用) |
+| `password` | string | ✗ | 重置密码,8–72 字(传则覆盖原密码) |
+
+## 出参
+响应 `200`:`AdminOut`（更新后的管理员)
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | 管理员 id |
+| `username` | string | 账号 |
+| `role` | string | 角色 |
+| `status` | string | 状态 |
+| `created_at` | datetime | 创建时间(UTC) |
+| `last_login_at` | datetime \| null | 上次登录时间 |
+
+## 错误码
+- `400` 不能禁用自己(`admin_id == 当前 admin.id` 且 `status=disabled`) / 无任何变更字段(三字段全空)
+- `401` 未带 admin token / token 无效或过期 / 管理员被禁用
+- `403` 角色不足(仅 super_admin)
+- `404` 管理员不存在
+- `422` `role`/`status` 非法枚举 / `password` 长度不在 8–72
+
+## 说明
+- 更新成功后写一条审计:`action=admin.update`、`target_type=admin`、`target_id=admin_id`、`detail` 为本次实际变更字段(如 `{"role": "...", "status": "...", "password": "reset"}`,密码只记 `reset` 不记明文)。见 [admin_audit_log](../database/admin_audit_log.md)。
+- 数据表见 [admin_user](../database/admin_user.md)。
@@ -0,0 +1,26 @@
+# GET /admin/api/admins — 管理员列表
+
+> 所属:Admin·Accounts 组（前缀 `/admin/api/admins`） | 鉴权:Bearer admin_token（角色:super_admin） | [← 返回 API 索引](../../README.md)
+
+## 入参
+无（按 `id` 升序返回全部,无分页）
+
+## 出参
+响应 `200`:`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` 未带 admin token / token 无效或过期 / 管理员被禁用
+- `403` 角色不足(仅 super_admin 可访问,detail 形如 `role 'operator' not allowed (need one of [...])`)
+
+## 说明
+账号管理整组(`/admin/api/admins`)的角色守卫为 `require_role()` 无参,即仅 `super_admin` 通过。数据表见 [admin_user](../database/admin_user.md)。