feat(api): 实现三端统一的JSON API响应契约
- 新增`api_response.py`统一响应封装工具类,提供标准成功/错误响应构造方法 - 重构WonderQ-Admin全局异常处理器,将所有异常转换为标准响应格式 - 修改所有公共和管理端接口的返回逻辑,统一使用`code`(与HTTP状态码一致)、`msg`和`data`的三层结构 - 新增`api-response-contract.md`文档,定义完整的三端统一JSON响应规范 - 更新所有领域API文档,明确业务数据需位于`data`字段内,补充响应格式说明 - 为WonderQ-MiniAPP和WonderQ-Admin-UI新增响应解析逻辑和类型定义,自动完成协议校验和错误处理 - 更新所有测试用例,适配新的响应结构确保接口符合契约要求 - 新增`module-config-api.md`模块配置API文档,补充站点模块配置的接口约定 - 更新项目README文档,调整文档分类顺序将响应契约置于首位
This commit is contained in:
@@ -10,6 +10,8 @@
|
||||
| 管理前端 | `WonderQ-Admin-UI` | 维护首页结构、目的地、线索和页面模块配置 | `admin-api-requirements.md`、`module-config-api.md` |
|
||||
| 前台 MiniAPP | `WonderQ-MiniAPP` | H5 与微信小程序前台展示、咨询和线索提交 | `public-api.md` |
|
||||
|
||||
三端所有 JSON 接口还必须遵守 [api-response-contract.md](./api-response-contract.md):成功业务数据位于 `data`,失败为 `data: null`,`code` 必须等于 HTTP 状态码。
|
||||
|
||||
## 本地启动顺序
|
||||
|
||||
1. 确认 Docker Desktop 已运行,然后启动后端依赖和数据库迁移。
|
||||
@@ -72,6 +74,7 @@ yarn dev:mp-weixin
|
||||
- `GET /health` 返回服务健康状态。
|
||||
- `GET /api/public/site-config` 返回前台所需数组字段。
|
||||
- `POST /api/admin/auth/login` 能返回 token 和 user。
|
||||
- 使用客户端或 curl 检查响应顶层包含数字 `code`、字符串 `msg` 和 `data`;不能继续接受旧的未包裹响应。
|
||||
|
||||
管理端联调重点:
|
||||
|
||||
@@ -84,6 +87,7 @@ MiniAPP 联调重点:
|
||||
- `site-config` 失败时仍能回退本地内容。
|
||||
- 首页模块按 Public API 字段渲染,不依赖后台未发布或未启用数据。
|
||||
- 线索提交调用 `POST /api/public/leads`,失败时显示可理解错误。
|
||||
- 首页、玩法、路线详情、管家、团队共创和客片案例请求都由公共 API 层解包 `data`,页面不重复解包。
|
||||
|
||||
## 路线详情三端联调
|
||||
|
||||
@@ -101,6 +105,7 @@ MiniAPP 联调重点:
|
||||
## 接口变更流程
|
||||
|
||||
1. 先更新契约文档。
|
||||
- 响应包裹、错误结构或状态码变化:更新 `api-response-contract.md`。
|
||||
- Public API 变更:更新 `public-api.md`。
|
||||
- Admin API 变更:更新 `admin-api-requirements.md`。
|
||||
2. 后端实现或调整接口,并补充对应验证。
|
||||
|
||||
Reference in New Issue
Block a user