duanshuwen/WonderQ-Project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 清理过时文档并更新管理端名称

Browse Source 
删除home-api.md、team-building-api.md等废弃文档
统一替换所有文档中的`WonderQ-Admin-UI`为`WonderQ-Admin-UI-Vue`
更新README.md与联调文档的内容与路径
修正各API文档的过时描述，移除废弃的迁移说明与本地mock依赖
整理docs/README.md的文档索引，优化阅读路径
This commit is contained in:
duanshuwen
2026-08-26 19:41:15 +08:00
parent 8de6ea01d0
commit e8eb8614f0
17 changed files with 143 additions and 1754 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/admin-api-requirements.md
View File

@@ -1,14 +1,14 @@
# WonderQ Admin API 接口需求
本文档描述 `WonderQ-Admin-UI` 当前使用的 Admin API。接口负责站点内容维护、素材、发布和需求线索管理。
本文档描述 `WonderQ-Admin-UI-Vue` 当前使用的 Admin API。接口负责站点内容维护、素材、发布、权限和需求线索管理。
玩法分类和路线管理的字段、嵌套路由、排序与删除约束见 [wanfa-api.md](./wanfa-api.md)。该文档是本主契约的玩法领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI`。
玩法分类和路线管理的字段、嵌套路由、排序与删除约束见 [wanfa-api.md](./wanfa-api.md)。该文档是本主契约的玩法领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI-Vue`。
管家顾问资料管理的字段、图片、排序与删除约束见 [concierge-api.md](./concierge-api.md)。该文档是本主契约的管家领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI`。
管家顾问资料管理的字段、图片、排序与删除约束见 [concierge-api.md](./concierge-api.md)。该文档是本主契约的管家领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI-Vue`。
详情展示内容的字段、图片、排序与商品领域隔离约束见 [detail-api.md](./detail-api.md)。该文档是本主契约的详情领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI`。
详情展示内容的字段、图片、排序与商品领域隔离约束见 [detail-api.md](./detail-api.md)。该文档是本主契约的详情领域补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI-Vue`。
首页体验、团队共创和极境视界内容的字段、图片、排序与商品领域隔离约束见 [home-api.md](./home-api.md)。该文档是本主契约的首页内容补充，适用端为 `WonderQ-Admin` 和 `WonderQ-Admin-UI`。
首页和用车站点模块的字段、单例、排序与删除约束见 [module-config-api.md](./module-config-api.md)。
所有 Admin JSON 接口遵循 [三端统一 API 响应契约](./api-response-contract.md)。
@@ -31,10 +31,18 @@
| `POST` | `/api/admin/auth/logout` | 撤销当前后台会话 |
| `GET` | `/api/admin/me` | 当前后台用户 |
| `GET` | `/api/admin/system/profile` | 当前用户、角色、权限码和动态菜单 |
| `GET/POST/PATCH` | `/api/admin/system/users` | 管理后台用户 |
| `GET/POST/PATCH` | `/api/admin/system/roles` | 管理角色和数据范围 |
| `GET/POST/PATCH` | `/api/admin/system/menus` | 管理目录、页面和按钮 |
| `GET/POST/PATCH` | `/api/admin/system/depts` | 管理部门 |
| `GET` | `/api/admin/system/users` | 查询后台用户 |
| `POST` | `/api/admin/system/users` | 新增后台用户 |
| `PATCH` | `/api/admin/system/users/{userId}` | 更新后台用户 |
| `GET` | `/api/admin/system/roles` | 查询管理角色和数据范围 |
| `POST` | `/api/admin/system/roles` | 新增管理角色 |
| `PATCH` | `/api/admin/system/roles/{roleId}` | 更新管理角色 |
| `GET` | `/api/admin/system/menus` | 查询目录、页面和按钮 |
| `POST` | `/api/admin/system/menus` | 新增目录、页面或按钮 |
| `PATCH` | `/api/admin/system/menus/{menuId}` | 更新目录、页面或按钮 |
| `GET` | `/api/admin/system/depts` | 查询部门 |
| `POST` | `/api/admin/system/depts` | 新增部门 |
| `PATCH` | `/api/admin/system/depts/{deptId}` | 更新部门 |
| `GET` | `/api/admin/dashboard` | 工作台统计和最近线索 |
| `GET` | `/api/admin/site-config` | 获取全部站点配置 |
| `POST` | `/api/admin/site-config/{module}` | 新增模块项 |
@@ -95,13 +103,13 @@ type SiteModule =
{ "email": "admin@example.test", "password": "<password>" }
```
成功响应包裹为 `data: { token, accessToken, expiresIn, user: { id, email, name, role } }`。`token` 保留给过渡期 React 管理端，`accessToken` 为短时访问令牌；Refresh Token 只通过同域 HttpOnly Cookie 返回，不进入 JSON。
成功响应包裹为 `data: { token, accessToken, expiresIn, user: { id, email, name, role } }`。`accessToken` 是短时访问令牌，`token` 是当前响应中的同值兼容字段；Refresh Token 只通过同域 HttpOnly Cookie 返回，不进入 JSON。
管理员登录、刷新和退出依赖 Redis 会话存储。Refresh Token 轮换后旧令牌立即失效；Redis 不可用时认证接口返回 `503`，不降级为无会话校验。
`/api/admin/system/profile` 返回 `roles`、`permissions`、`menus`、`dataScopes` 和 `deptIds`。菜单只返回启用且可见的目录/页面，按钮菜单保留在页面节点的 `children` 中；前端组件只能从预注册组件白名单加载 `component`。
角色数据范围使用以下五个编码：`all`（全部）、`dept`（当前部门）、`dept_and_children`（当前部门及子部门）、`custom_dept`（自定义部门）、`self`（本人）。运营资源通过 `deptId` 和 `createdById` 归属字段执行查询过滤；资源归属迁移完成前不得在生产环境切换非管理员角色。
角色数据范围使用以下五个编码：`all`（全部）、`dept`（当前部门）、`dept_and_children`（当前部门及子部门）、`custom_dept`（自定义部门）、`self`（本人）。运营资源通过 `deptId` 和 `createdById` 归属字段执行查询过滤。
登录按 IP 与账号组合执行 Redis 限流，默认 60 秒最多 5 次；权限菜单缓存默认 300 秒。Redis 故障不能放行权限检查，缓存不可用时只能重新读取数据库，认证会话和限流不可用时返回 `503`。