实现前端演示数据受控生成接口
This commit is contained in:
andy
@@ -14,6 +14,7 @@
|
||||
| P0 | 任务详情读取接口 `GET /api/reservation/tasks/{taskId}` | 任务详情页动态渲染 | 已完成第一版，已补来源邮件字段和 3.0 字段元数据 |
|
||||
| P0 | 任务详情操作接口 | 任务详情保存、确认、OPERA、审计 | 已完成；前端可直接接入 |
|
||||
| P0 | 邮件会话详情接口 `GET /api/source-messages/{sourceMessageId}/conversation` | 邮件会话详情页 | 已完成第一版 |
|
||||
| 联调 | 演示数据 seed 接口 `POST /api/system/reservation/demo-data` | 本地 / test 前端页面看效果 | 已完成；仅 dev/test 受控使用 |
|
||||
| P1 | Message Notification 列表 / 详情接口 | 信息提醒页或订单详情只读卡片 | 未完成独立接口；可先通过任务列表 / 任务详情展示 `INFORMATIONAL_MESSAGE` |
|
||||
| P1 | 任务卡前端字段白名单元数据接口 | 字段白名单调试、版本对齐 | 未完成；若任务详情已透出完整元数据，可后置 |
|
||||
| 后置 | 普通任务切换订单接口 | 任务详情订单归属调整 | 未完成；已确认后置 |
|
||||
@@ -38,7 +39,8 @@
|
||||
| `GET /api/source-messages/{id}/original` | 已完成单封原文受控读取 | 谨慎接入 | 只能读单封邮件，不能返回同一 conversation 全量邮件。 |
|
||||
| `GET /api/reservation/orders` | 已完成第一版 | 可以 | 默认查询全部订单状态；`open_task_count` 排除 `COMPLETED` 和 `FAILED`。 |
|
||||
| `GET /api/source-messages/{sourceMessageId}/conversation` | 已完成第一版 | 可以 | 返回完整 text/html、媒体外链和关联订单 / 任务摘要；前端不传原文读取 key。 |
|
||||
| `GET /api/source-message-conversations/{externalConversationId}` | 未发现后端实现 | 不可以 | 可作为后端偏好的邮件会话详情路径。 |
|
||||
| `POST /api/system/reservation/demo-data` | 已完成 | 仅本地 / test 联调可用 | 默认关闭，必须后端配置访问口令；不能作为生产页面接口。 |
|
||||
| `GET /api/source-message-conversations/{externalConversationId}` | 未发现后端实现 | 不可以 | 历史讨论过的候选路径，当前不提供；前端统一使用 `GET /api/source-messages/{sourceMessageId}/conversation`。 |
|
||||
| `GET /api/reservation/message-notifications` | 未发现后端实现 | 不可以 | 如需独立信息提醒页再新增；第一版可先用任务接口过滤。 |
|
||||
| `GET /api/reservation/task-card-field-whitelist` | 未发现后端实现 | 不可以 | 若任务详情 `fields[]` 已补齐 3.0 元数据，可后置。 |
|
||||
|
||||
@@ -155,7 +157,7 @@ GET /api/reservation/orders/{orderId}
|
||||
| `orderId` | 是 | 订单 ID。 |
|
||||
| `hotel_id` | 否 | 酒店 ID。第一版如果只有单酒店，可为空。 |
|
||||
| `include_tasks` | 否 | 是否返回任务时间线，默认 `true`。 |
|
||||
| `include_source_summary` | 否 | 是否返回来源消息摘要，默认 `true`。 |
|
||||
| `include_source_summary` | 否 | 是否返回来源消息摘要，默认 `true`；第一版参数保留，前端暂不要依赖它做字段裁剪。 |
|
||||
|
||||
建议返参：
|
||||
|
||||
@@ -227,7 +229,7 @@ GET /api/reservation/orders
|
||||
| `order_status` | 否 | `TEMPORARY`、`ACTIVE`、`ENDED`、`LOGIC_DELETED`。 |
|
||||
| `group_code` | 否 | 按 Group Code 精确或模糊查询，后端决定。 |
|
||||
| `confirmation_number` | 否 | 按 Confirmation No 查询。 |
|
||||
| `keyword` | 否 | 前端搜索框统一关键词。 |
|
||||
| `keyword` | 否 | 前端搜索框统一关键词；后端匹配订单字段，也会匹配来源消息安全摘要命中的 SourceMessage ID。 |
|
||||
| `page_num` | 否 | 页码。 |
|
||||
| `page_size` | 否 | 每页条数。 |
|
||||
|
||||
@@ -258,7 +260,48 @@ GET /api/reservation/orders
|
||||
}
|
||||
```
|
||||
|
||||
## 6. 邮件会话详情接口
|
||||
## 6. 前端联调演示数据 seed 接口
|
||||
|
||||
建议路径：
|
||||
|
||||
```text
|
||||
POST /api/system/reservation/demo-data
|
||||
```
|
||||
|
||||
当前状态：后端已完成第一版。该接口只用于本地 / test 联调造数，默认关闭，不是生产业务页面接口。
|
||||
|
||||
启用条件：
|
||||
|
||||
| 配置 | 说明 |
|
||||
| --- | --- |
|
||||
| `reservation.demo-data.enabled=true` | 显式启用接口，也可用环境变量 `RESERVATION_DEMO_DATA_ENABLED=true`。 |
|
||||
| `reservation.demo-data.access-key` | 配置访问口令，也可用环境变量 `RESERVATION_DEMO_DATA_ACCESS_KEY`。 |
|
||||
| `X-TH-Hotel-Demo-Data-Key` | 请求头必须携带，与后端配置口令一致。 |
|
||||
|
||||
请求示例：
|
||||
|
||||
```json
|
||||
{
|
||||
"hotel_id": "HOTEL-TEST",
|
||||
"run_label": "frontend-smoke"
|
||||
}
|
||||
```
|
||||
|
||||
返回说明：
|
||||
|
||||
| 字段 | 说明 |
|
||||
| --- | --- |
|
||||
| `demo_run_id` | 本次 seed 唯一关键词，可用于任务列表 / 订单列表搜索。 |
|
||||
| `source_messages[]` | 生成的来源消息 ID、外部消息 ID 和外部会话 ID。 |
|
||||
| `orders[]` | 生成的订单 ID、订单状态和展示键。 |
|
||||
| `tasks[]` | 生成的任务 ID、任务类型、任务 subtype 和任务状态。 |
|
||||
| `entrypoints` | 可直接访问的任务列表、订单列表、订单详情、任务详情、邮件会话详情 URL。 |
|
||||
|
||||
第一版 seed 覆盖：队列阻塞、已完成 OPERA 模拟、OPERA 失败可重试、Fallback 人工复核、Message Notification、邮件会话完整 HTML / 附件 / 内联图片。
|
||||
|
||||
前端注意：不要把访问口令写入前端仓库、浏览器环境变量或构建产物；该接口只能由本地联调人员手动调用或由受控测试脚本调用。
|
||||
|
||||
## 7. 邮件会话详情接口
|
||||
|
||||
建议优先路径：
|
||||
|
||||
@@ -266,13 +309,13 @@ GET /api/reservation/orders
|
||||
GET /api/source-messages/{sourceMessageId}/conversation
|
||||
```
|
||||
|
||||
可选补充路径：
|
||||
历史候选路径，当前不提供：
|
||||
|
||||
```text
|
||||
GET /api/source-message-conversations/{externalConversationId}
|
||||
```
|
||||
|
||||
当前状态：后端已完成第一版。前端入口从某个任务的 `source_message_id` 进入，后端根据该 SourceMessage 找到 `external_conversation_id`，再返回同一邮件会话下的全部邮件。
|
||||
当前状态：`GET /api/source-messages/{sourceMessageId}/conversation` 已完成第一版。前端入口从某个任务的 `source_message_id` 进入，后端根据该 SourceMessage 找到 `external_conversation_id`，再返回同一邮件会话下的全部邮件。
|
||||
|
||||
中文说明：
|
||||
|
||||
@@ -347,7 +390,7 @@ GET /api/source-message-conversations/{externalConversationId}
|
||||
}
|
||||
```
|
||||
|
||||
## 7. 任务详情接口字段元数据扩展
|
||||
## 8. 任务详情接口字段元数据扩展
|
||||
|
||||
建议路径：
|
||||
|
||||
@@ -451,7 +494,7 @@ GET /api/reservation/tasks/{taskId}
|
||||
- `result_type`、`task_type`、`task_subtype`、`default_value_source` 当前从后端字段矩阵定义透出。
|
||||
- 如果后端已有更细的字段来源或适用场景元数据，可后续再扩展 `field_source`、`applicable_scenario`，不作为本轮 P0 阻塞项。
|
||||
|
||||
## 8. Message Notification 列表 / 详情接口
|
||||
## 9. Message Notification 列表 / 详情接口
|
||||
|
||||
当前状态：未发现后端独立 Message Notification 列表 / 详情接口。当前后端已经支持 `INFORMATIONAL_MESSAGE` 任务类型进入任务体系，第一版前端可以先通过 `GET /api/reservation/tasks?task_type=INFORMATIONAL_MESSAGE` 和 `GET /api/reservation/tasks/{taskId}` 展示信息提醒任务。仅当产品确认需要独立“信息提醒页”时，再新增本节接口。
|
||||
|
||||
@@ -492,7 +535,7 @@ GET /api/reservation/message-notifications/{taskId}
|
||||
}
|
||||
```
|
||||
|
||||
## 9. 任务卡前端字段白名单元数据接口
|
||||
## 10. 任务卡前端字段白名单元数据接口
|
||||
|
||||
是否需要该接口待确认。如果任务详情接口 `fields[]` 已透出 3.0 所需元数据，则第一版可以不做独立白名单接口；如果后续需要字段矩阵调试页、版本对齐页或前端预加载全部任务卡配置，再补独立接口。
|
||||
|
||||
@@ -530,7 +573,7 @@ GET /api/reservation/task-card-field-whitelist
|
||||
}
|
||||
```
|
||||
|
||||
## 10. 已确认后置接口
|
||||
## 11. 已确认后置接口
|
||||
|
||||
普通任务切换订单接口继续后置，前端暂不开发提交能力。后续如果恢复开发，建议另行确认：
|
||||
|
||||
@@ -559,7 +602,7 @@ POST /api/reservation/tasks/{taskId}/order-binding
|
||||
}
|
||||
```
|
||||
|
||||
## 11. 待确认问题
|
||||
## 12. 待确认问题
|
||||
|
||||
- 订单列表、任务列表当前统一使用 `items + page` 分页结构；邮件会话详情不分页，返回同一会话全部邮件。
|
||||
- 邮件会话详情接口已优先使用 `GET /api/source-messages/{sourceMessageId}/conversation`。
|
||||
|
||||
Reference in New Issue
Block a user