# 接口契约清单 ## 前端 API 基础配置 位置：`src/lib/config.ts`、`src/lib/api.ts` ```ts API_BASE_URL = import.meta.env.VITE_API_BASE_URL || 'http://:8000' timeout: 30000 ``` 前端 request interceptor 会从 localStorage 读取 `token`，附加： ```http Authorization: Bearer ``` 当前后端多数接口没有鉴权依赖，所以这个 header 主要是前端侧行为。 ## 前端封装的 API | 函数 | 方法与路径 | 状态 | 说明 | |------|------------|------|------| | `login(username, password)` | `POST /api/auth/login` | 对齐 | 后端返回 `{ token, username }`，前端只使用 token | | `getProjects()` | `GET /api/projects` | 对齐 | 前端映射 `frame_count`、`thumbnail_url` 等字段 | | `createProject(payload)` | `POST /api/projects` | 对齐 | 支持 `name`、`description`、`parse_fps` | | `updateProject(id, payload)` | `PATCH /api/projects/{id}` | 对齐 | 后端是 `PATCH /api/projects/{id}` | | `deleteProject(id)` | `DELETE /api/projects/{id}` | 对齐 | 当前 UI 未明显接入 | | `getTemplates()` | `GET /api/templates` | 对齐 | 前端从 `mapping_rules` 取 classes/rules | | `createTemplate(payload)` | `POST /api/templates` | 对齐 | 后端会打包 classes/rules 到 mapping_rules | | `updateTemplate(id, payload)` | `PATCH /api/templates/{id}` | 对齐 | 模板编辑页使用 | | `deleteTemplate(id)` | `DELETE /api/templates/{id}` | 对齐 | 模板编辑页使用 | | `uploadMedia(file, projectId)` | `POST /api/media/upload` | 对齐 | multipart form-data | | `uploadDicomBatch(files, projectId)` | `POST /api/media/upload/dicom` | 对齐 | multipart form-data | | `parseMedia(projectId)` | `POST /api/media/parse?project_id=...` | 对齐 | 创建异步拆帧任务并返回 task | | `getTask(taskId)` | `GET /api/tasks/{task_id}` | 对齐 | 查询异步任务状态 | | `getProjectFrames(projectId)` | `GET /api/projects/{id}/frames` | 对齐 | 后端返回预签名 image_url | | `predictMask(payload)` | `POST /api/ai/predict` | 对齐 | 前端发送 `image_id/prompt_type/prompt_data/model`，并把后端 `polygons` 转为 `masks[].pathData` | | `getAiModelStatus(selectedModel?)` | `GET /api/ai/models/status` | 对齐 | 返回 GPU、SAM 2、SAM 3 的真实运行状态 | | `getProjectAnnotations(projectId, frameId?)` | `GET /api/ai/annotations` | 对齐 | 前端加载工作区时用于回显已保存标注 | | `saveAnnotation(payload)` | `POST /api/ai/annotate` | 对齐 | 工作区归档保存当前项目未保存 mask | | `updateAnnotation(annotationId, payload)` | `PATCH /api/ai/annotations/{annotation_id}` | 对齐 | 工作区归档保存 dirty mask | | `deleteAnnotation(annotationId)` | `DELETE /api/ai/annotations/{annotation_id}` | 对齐 | 工作区清空当前帧已保存标注 | | `getDashboardOverview()` | `GET /api/dashboard/overview` | 对齐 | Dashboard 初始统计、队列和活动日志 | | `exportCoco(projectId)` | `GET /api/export/{projectId}/coco` | 对齐 | 后端实际是 `GET /api/export/{project_id}/coco` | ## 后端 FastAPI 接口 以下列表来自当前运行的 OpenAPI： | 方法 | 路径 | 用途 | |------|------|------| | POST | `/api/auth/login` | 登录 | | POST | `/api/projects` | 创建项目 | | GET | `/api/projects` | 项目列表 | | GET | `/api/projects/{project_id}` | 项目详情 | | PATCH | `/api/projects/{project_id}` | 更新项目 | | DELETE | `/api/projects/{project_id}` | 删除项目 | | POST | `/api/projects/{project_id}/frames` | 添加帧记录 | | GET | `/api/projects/{project_id}/frames` | 项目帧列表 | | GET | `/api/projects/{project_id}/frames/{frame_id}` | 单帧详情 | | POST | `/api/templates` | 创建模板 | | GET | `/api/templates` | 模板列表 | | GET | `/api/templates/{template_id}` | 模板详情 | | PATCH | `/api/templates/{template_id}` | 更新模板 | | DELETE | `/api/templates/{template_id}` | 删除模板 | | POST | `/api/media/upload` | 上传视频/图片/DICOM 单文件 | | POST | `/api/media/upload/dicom` | 批量上传 DICOM | | POST | `/api/media/parse` | 创建 Celery 拆帧任务 | | GET | `/api/tasks` | 查询后台任务列表 | | GET | `/api/tasks/{task_id}` | 查询单个后台任务 | | POST | `/api/ai/predict` | SAM 2 / SAM 3 可选推理 | | GET | `/api/ai/models/status` | GPU 和 SAM 模型状态 | | POST | `/api/ai/auto` | 自动分割 | | POST | `/api/ai/annotate` | 保存 AI 标注 | | GET | `/api/ai/annotations` | 查询项目标注，可选按帧过滤 | | PATCH | `/api/ai/annotations/{annotation_id}` | 更新已保存标注 | | DELETE | `/api/ai/annotations/{annotation_id}` | 删除已保存标注 | | GET | `/api/dashboard/overview` | Dashboard 聚合快照 | | GET | `/api/export/{project_id}/coco` | 导出 COCO JSON | | GET | `/api/export/{project_id}/masks` | 导出 PNG mask ZIP | | GET | `/health` | 健康检查 | | WS | `/ws/progress` | WebSocket 进度通道，未出现在 OpenAPI paths 中 | ## 关键请求体 ### 登录 ```json { "username": "admin", "password": "123456" } ``` ### 创建项目 ```json { "name": "example.mp4", "description": "导入说明", "parse_fps": 30 } ``` ### 创建/更新模板 ```json { "name": "腹腔镜胆囊切除术", "color": "#06b6d4", "z_index": 0, "classes": [ { "id": "cls-1", "name": "胆囊", "color": "#ffae00", "zIndex": 280, "category": "腹腔镜胆囊切除术" } ], "rules": [] } ``` ### AI 推理请求体 前端 `predictMask()` 当前已适配后端 `PredictRequest`： ```json { "image_id": 123, "model": "sam2", "prompt_type": "point", "prompt_data": { "points": [[0.5, 0.5]], "labels": [1] } } ``` `prompt_type` 支持： - `point` - `box` - `semantic`，选择 `sam3` 时进入 SAM 3 文本语义推理；选择 `sam2` 时仍回退到 auto segmentation 后端响应： ```json { "polygons": [ [[0.25, 0.25], [0.75, 0.25], [0.75, 0.75], [0.25, 0.75]] ], "scores": [0.5] } ``` 前端会把上面的 `polygons` 转成： ```json { "masks": [ { "pathData": "M 160 90 L 480 90 L 480 270 L 160 270 Z", "segmentation": [[160, 90, 480, 90, 480, 270, 160, 270]], "bbox": [160, 90, 320, 180] } ] } ``` ## 已完成的接口对齐 - `updateProject()` 已从 `PUT` 改为 `PATCH`。 - `exportCoco()` 已从 `/api/export/coco/{projectId}` 改为 `/api/export/{projectId}/coco`。 - Canvas 已使用真实 `frame.id` 作为 `image_id`。 - 点和框坐标已转成后端需要的归一化坐标。 - 后端 `polygons` 已在前端转成 Konva 可渲染的 path。 - `saveAnnotation()` 已接入 `POST /api/ai/annotate`。 - `getProjectAnnotations()` 已接入 `GET /api/ai/annotations`。 - `updateAnnotation()` 已接入 `PATCH /api/ai/annotations/{annotationId}`。 - `deleteAnnotation()` 已接入 `DELETE /api/ai/annotations/{annotationId}`。 - `parseMedia()` 已改为创建 Celery 后台任务，并返回 `ProcessingTask`。 - `getTask()` 已接入 `GET /api/tasks/{taskId}`。 - `getDashboardOverview()` 已从 `processing_tasks` 聚合解析队列。 - 工作区导出按钮已调用 `exportCoco()`，并会先保存未归档 mask。 ## 仍需处理的接口问题 - WebSocket 地址已从 `VITE_WS_PROGRESS_URL` 读取，未配置时从 `API_BASE_URL` 推导；部署时仍要确认浏览器能访问该地址。 - Celery worker 进度会写 PostgreSQL 任务表，同时发布到 Redis `seg:progress`；FastAPI 订阅后广播到 `/ws/progress`。 - 已保存标注目前支持分类级更新和整帧清空删除；逐点几何编辑器尚未实现。