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:
@@ -4,6 +4,8 @@
|
||||
>
|
||||
> 状态:已实现。本文档约定 `WonderQ-Admin`、`WonderQ-Admin-UI` 的管家管理接口,并记录 MiniAPP 使用的对应 Public API。
|
||||
|
||||
所有 JSON 响应遵循 [三端统一 API 响应契约](./api-response-contract.md),成功业务对象位于 `data`,失败时 `data` 为 `null`。
|
||||
|
||||
## 领域边界
|
||||
|
||||
管家管理只维护管家顾问卡片资料:
|
||||
@@ -48,7 +50,7 @@ MiniAPP Public API:
|
||||
- 变更接口返回最新顾问对象;排序接口返回排序后的 `items`。
|
||||
- ID 由后端生成并作为非空字符串返回。
|
||||
- 空列表返回 `[]`,不能返回 `null` 或省略字段。
|
||||
- 失败响应沿用 Admin API 约定,包含 `message`、`code` 和可选的 `details`。
|
||||
- 成功结果放入 `data`;失败返回数字 `code`、`msg`、`data: null`,可选 `errorCode` 和 `details`。
|
||||
|
||||
## 数据类型
|
||||
|
||||
@@ -129,23 +131,27 @@ Authorization: Bearer <admin-jwt>
|
||||
|
||||
```json
|
||||
{
|
||||
"advisors": [
|
||||
{
|
||||
"id": "advisor-001",
|
||||
"avatar": "https://example.test/assets/advisor-avatar.jpg",
|
||||
"name": "示例顾问",
|
||||
"role": "SENIOR TRAVEL ADVISOR",
|
||||
"details": [
|
||||
{ "icon": "calendar", "label": "服务经验:8年" },
|
||||
{ "icon": "navigate", "label": "擅长领域:自然探索" }
|
||||
],
|
||||
"qrImage": "https://example.test/assets/advisor-qr.png",
|
||||
"isActive": true,
|
||||
"sortOrder": 0,
|
||||
"createdAt": "2026-01-01T00:00:00Z",
|
||||
"updatedAt": "2026-01-01T00:00:00Z"
|
||||
}
|
||||
]
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": {
|
||||
"advisors": [
|
||||
{
|
||||
"id": "advisor-001",
|
||||
"avatar": "https://example.test/assets/advisor-avatar.jpg",
|
||||
"name": "示例顾问",
|
||||
"role": "SENIOR TRAVEL ADVISOR",
|
||||
"details": [
|
||||
{ "icon": "calendar", "label": "服务经验:8年" },
|
||||
{ "icon": "navigate", "label": "擅长领域:自然探索" }
|
||||
],
|
||||
"qrImage": "https://example.test/assets/advisor-qr.png",
|
||||
"isActive": true,
|
||||
"sortOrder": 0,
|
||||
"createdAt": "2026-01-01T00:00:00Z",
|
||||
"updatedAt": "2026-01-01T00:00:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -173,7 +179,7 @@ Content-Type: application/json
|
||||
}
|
||||
```
|
||||
|
||||
成功返回 `201` 和新建的 `ConciergeAdvisorRecord`。未传 `sortOrder` 时追加到当前最大顺序之后。
|
||||
成功返回 `201` 和 `data` 内新建的 `ConciergeAdvisorRecord`。未传 `sortOrder` 时追加到当前最大顺序之后。
|
||||
|
||||
### 编辑顾问
|
||||
|
||||
@@ -194,7 +200,7 @@ Content-Type: application/json
|
||||
}
|
||||
```
|
||||
|
||||
成功返回更新后的 `ConciergeAdvisorRecord`。不存在的顾问返回 `404 CONCIERGE_ADVISOR_NOT_FOUND`。
|
||||
成功返回 `data` 内更新后的 `ConciergeAdvisorRecord`。不存在的顾问返回 `404`,业务码为 `CONCIERGE_ADVISOR_NOT_FOUND`。
|
||||
|
||||
### 删除顾问
|
||||
|
||||
@@ -206,7 +212,11 @@ Authorization: Bearer <admin-jwt>
|
||||
删除成功返回:
|
||||
|
||||
```json
|
||||
{ "id": "advisor-001" }
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": { "id": "advisor-001" }
|
||||
}
|
||||
```
|
||||
|
||||
删除后应重新规范化剩余顾问的 `sortOrder`,从 `0` 开始连续编号。若业务要求至少保留一名启用顾问,服务端在删除最后一名启用顾问时返回 `409 CONCIERGE_LAST_ACTIVE_ADVISOR`,否则允许删除并由前台处理空状态。
|
||||
@@ -228,7 +238,11 @@ Content-Type: application/json
|
||||
成功响应:
|
||||
|
||||
```json
|
||||
{ "items": [] }
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": { "items": [] }
|
||||
}
|
||||
```
|
||||
|
||||
其中 `items` 为更新 `sortOrder` 后的 `ConciergeAdvisorRecord[]`。缺少 ID、包含未知 ID 或出现重复 ID 时返回 `400 CONCIERGE_REORDER_INVALID`。
|
||||
@@ -247,7 +261,7 @@ type PublicConciergeResponse = {
|
||||
};
|
||||
```
|
||||
|
||||
顾问列表为空时返回 `{ "advisors": [] }`。MiniAPP 应在请求期间展示 loading,失败时展示错误和重试入口,响应字段缺失时通过归一化函数过滤无效顾问。
|
||||
顾问列表为空时返回 `data: { "advisors": [] }`。MiniAPP 应在请求期间展示 loading,失败时展示错误和重试入口,响应字段缺失时通过归一化函数过滤无效顾问。
|
||||
|
||||
## 图片与素材
|
||||
|
||||
|
||||
Reference in New Issue
Block a user