docs: Web UI 设计评审修订(v1.0→v1.1,7 项发现全修 + api §2.2 write_instruction)

This commit is contained in:
lhl
2026-08-09 13:28:38 +08:00
parent 69f04ecda2
commit 1a3c829d4c
6 changed files with 376 additions and 99 deletions
+8 -1
View File
@@ -55,7 +55,14 @@ FastAPI Orchestrator(单进程,默认)
| Method | Path | 说明 | 请求体 | 响应 | 触发状态转移 |
|--------|------|------|--------|------|-------------|
| POST | `/api/sessions/{id}/files` | 上传文件(multipart | `file` + `file_type`requirements/template/rules/existing_system | `{file_id, file_name, size}` | `uploading` 保持 |
| POST | `/api/sessions/{id}/files` | 上传文件(multipart | `file` + `file_type``requirements`/`template`/`write_instruction`/`rules`/`existing_system` | `{file_id, file_name, size}` | `uploading` 保持 |
> `file_type` 取值说明(v1.1 修订,随 web-ui-design §3.1 补齐大赛输入资料):
> - `requirements` — 要件定义 Excel(核心数据源)
> - `template` — 概要设计模板 docx(输出结构/样式)
> - `write_instruction` — 概要设计做成说明书 docx(各章作成指引;RAG 归类 Type A 写入规则,Parser 解析)
> - `rules` — 记入规则 / 图表规则等规则文档(可多个)
> - `existing_system` — 现系统源码或既有设计书(追加/改修场景)
| POST | `/api/sessions/{id}/start-parse` | 开始解析(全部文件上传完成后) | `{}` | `{task_id}`(解析异步执行) | `uploading → parsing` |
| GET | `/api/sessions/{id}/parse-result` | 获取解析结果 | — | `{structured_summary, sheets, template_sections}` | 只读 |