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:
@@ -6,38 +6,42 @@
|
||||
|
||||
后端开发:
|
||||
|
||||
1. `admin-api-requirements.md`
|
||||
2. `home-api.md`
|
||||
3. `wanfa-api.md`
|
||||
4. `concierge-api.md`
|
||||
5. `detail-api.md`
|
||||
6. `team-building-api.md`
|
||||
7. `public-api.md`
|
||||
|
||||
管理前端开发:
|
||||
|
||||
1. `integration-workflow.md`
|
||||
1. `api-response-contract.md`
|
||||
2. `admin-api-requirements.md`
|
||||
3. `home-api.md`
|
||||
4. `wanfa-api.md`
|
||||
5. `concierge-api.md`
|
||||
6. `detail-api.md`
|
||||
7. `team-building-api.md`
|
||||
8. `module-config-api.md`
|
||||
8. `public-api.md`
|
||||
|
||||
管理前端开发:
|
||||
|
||||
1. `api-response-contract.md`
|
||||
2. `integration-workflow.md`
|
||||
3. `admin-api-requirements.md`
|
||||
4. `home-api.md`
|
||||
5. `wanfa-api.md`
|
||||
6. `concierge-api.md`
|
||||
7. `detail-api.md`
|
||||
8. `team-building-api.md`
|
||||
9. `module-config-api.md`
|
||||
|
||||
MiniAPP 前台开发:
|
||||
|
||||
1. `integration-workflow.md`
|
||||
2. `wanfa-api.md`
|
||||
3. `detail-api.md`
|
||||
4. `team-building-api.md`
|
||||
5. `public-api.md`
|
||||
6. `development-status.md`
|
||||
1. `api-response-contract.md`
|
||||
2. `integration-workflow.md`
|
||||
3. `wanfa-api.md`
|
||||
4. `detail-api.md`
|
||||
5. `team-building-api.md`
|
||||
6. `public-api.md`
|
||||
7. `development-status.md`
|
||||
|
||||
## 文档清单
|
||||
|
||||
| 文档 | 作用 | 主要读者 |
|
||||
| --------------------------- | --------------------------------------------------------- | -------------- |
|
||||
| `api-response-contract.md` | 三端统一 JSON 响应包裹、错误和客户端解包规则 | 全部 |
|
||||
| `integration-workflow.md` | 三端本地启动、联调顺序、接口变更流程和验证命令 | 全部 |
|
||||
| `development-status.md` | 三端能力对接状态矩阵和优先联调路径 | 全部 |
|
||||
| `decisions.md` | 当前有效技术和文档决策 | 全部 |
|
||||
|
||||
Reference in New Issue
Block a user