admin
f020ff3b4f
后端能力： - 新增 Celery app、worker task、ProcessingTask 模型、/api/tasks 查询接口和 media_task_runner，将 /api/media/parse 改为创建后台任务并由 worker 执行 FFmpeg/OpenCV/pydicom 拆帧。 - 新增 Redis 进度事件模块和 FastAPI Redis pub/sub 订阅，将 worker 任务进度广播到 /ws/progress；Dashboard 后端概览接口改为聚合 projects/frames/annotations/templates/processing_tasks。 - 统一项目状态为 pending/parsing/ready/error，新增共享 status 常量，并让前端兼容归一化旧状态值。 - 扩展 AI 后端：新增 SAM registry、SAM2 真实运行状态、SAM3 状态检测与文本语义推理适配入口，以及 /api/ai/models/status GPU/模型状态接口。 - 补齐标注保存/更新/删除、COCO/PNG mask 导出相关后端契约和模板 mapping_rules 打包/解包行为。 前端能力： - 新增运行时 API/WS 地址推导配置，前端 API 封装对齐 FastAPI 路由、字段映射、任务轮询、标注归档、导出下载和 AI 预测响应转换。 - Dashboard 改为读取 /api/dashboard/overview，并订阅 WebSocket progress/complete/error/status 更新解析队列和实时流转记录。 - 项目库导入视频/DICOM 后创建项目、上传媒体、触发异步解析并刷新真实项目列表。 - 工作区加载真实帧、无帧时触发解析任务、回显已保存标注、保存未归档 mask、更新 dirty mask、清空当前帧后端标注、导出 COCO JSON。 - Canvas 支持当前帧点/框提示调用后端 AI、渲染推理/已保存 mask、应用模板分类并维护保存状态计数；时间轴按项目 fps 播放。 - AI 页面新增 SAM2/SAM3 模型选择，预测请求携带 model；侧边栏和工作区新增真实 GPU/SAM 状态徽标。 - 模板库和本体面板接入真实模板 CRUD、分类编辑、拖拽排序、JSON 导入、默认腹腔镜分类和本地自定义分类选择。 测试与文档： - 新增 Vitest 配置、前端测试 setup、API/config/websocket/store/组件测试，覆盖登录、项目库、Dashboard、Canvas、工作区、模型状态、时间轴、本体和模板库。 - 新增 pytest 后端测试夹具和 auth/projects/templates/media/AI/export/dashboard/tasks/progress 测试，使用 SQLite、fake MinIO、fake SAM registry 和 Redis monkeypatch 隔离外部服务。 - 新增 doc/ 文档结构，冻结当前需求、设计、接口契约、测试计划、前端逐元素审计、实现地图和后续实施计划，并同步更新 README 与 AGENTS。 验证： - conda run -n seg_server pytest backend/tests：27 passed。 - npm run test:run：54 passed。 - npm run lint、npm run build、compileall、git diff --check 均通过；Vite 仅提示大 chunk 警告。
104 lines
3.1 KiB
Markdown
104 lines
3.1 KiB
Markdown
# `/docs` 是什么
|
||
|
||
地址：
|
||
|
||
- 本机：`http://localhost:8000/docs`
|
||
- 局域网：`http://192.168.3.11:8000/docs`
|
||
|
||
这个页面不是文件列表，也不是项目文档目录。它是 FastAPI 自动生成的 Swagger UI，用来展示和调试后端 HTTP API。
|
||
|
||
## 为什么会自动出现
|
||
|
||
FastAPI 会根据代码里的路由和 Pydantic schema 自动生成 OpenAPI 描述，然后用 Swagger UI 展示出来。
|
||
|
||
相关代码在：
|
||
|
||
- `backend/main.py` 创建 `FastAPI(...)`
|
||
- `backend/routers/*.py` 定义 `@router.get(...)`、`@router.post(...)` 等接口
|
||
- `backend/schemas.py` 定义请求体和响应体
|
||
|
||
## 页面上 GET / POST / PATCH / DELETE 是什么
|
||
|
||
这些是 HTTP 方法，不是文件。
|
||
|
||
| 方法 | 含义 | 例子 |
|
||
|------|------|------|
|
||
| GET | 读取数据 | `GET /api/projects` 获取项目列表 |
|
||
| POST | 创建或触发动作 | `POST /api/media/upload` 上传文件 |
|
||
| PATCH | 局部更新 | `PATCH /api/templates/{template_id}` 更新模板 |
|
||
| DELETE | 删除 | `DELETE /api/projects/{project_id}` 删除项目 |
|
||
|
||
你看到的每一行，都是后端暴露给前端调用的一个接口。
|
||
|
||
## `/docs` 能做什么
|
||
|
||
可以：
|
||
|
||
- 查看后端目前有哪些接口。
|
||
- 展开接口查看参数、请求体和响应格式。
|
||
- 点击 `Try it out` 直接发请求测试后端。
|
||
- 检查接口返回错误，比如 400、401、404、500。
|
||
|
||
不能：
|
||
|
||
- 查看前端页面源码。
|
||
- 直接代表某个功能已经完整可用。
|
||
- 展示 WebSocket 的完整交互，因为 OpenAPI 主要描述 HTTP 接口。
|
||
|
||
## 和前端有什么关系
|
||
|
||
前端的 `src/lib/api.ts` 会调用这些接口。例如：
|
||
|
||
- 登录页调用 `/api/auth/login`
|
||
- 项目库调用 `/api/projects`
|
||
- 上传视频调用 `/api/media/upload`
|
||
- 拆帧调用 `/api/media/parse`
|
||
- 模板库调用 `/api/templates`
|
||
|
||
所以 `/docs` 是检查“后端提供了什么”的地方；前端是否真的用对了，还要对照 `src/lib/api.ts`。
|
||
|
||
## 目前通过 `/docs` 能看到的接口
|
||
|
||
当前后端接口包括：
|
||
|
||
- Auth：登录
|
||
- Projects：项目 CRUD、项目帧 CRUD
|
||
- Templates：模板 CRUD
|
||
- Media：上传视频/DICOM、触发拆帧
|
||
- AI：SAM 2 / SAM 3 可选推理、模型状态、自动分割、保存标注
|
||
- Export：导出 COCO JSON、导出 PNG masks
|
||
- Health：健康检查
|
||
|
||
## 为什么看起来像“列举文件和请求”
|
||
|
||
因为 Swagger UI 默认按接口分组，把每个 endpoint 展开成一行。它列举的是“后端可被调用的功能入口”，不是项目文件。
|
||
|
||
真正的项目文件在本地目录里，例如：
|
||
|
||
- 前端：`src/components/*.tsx`
|
||
- 后端路由：`backend/routers/*.py`
|
||
- 后端模型：`backend/models.py`
|
||
|
||
## 如何用 `/docs` 验证一个接口
|
||
|
||
以项目列表为例：
|
||
|
||
1. 打开 `/docs`。
|
||
2. 找到 `GET /api/projects`。
|
||
3. 点开。
|
||
4. 点击 `Try it out`。
|
||
5. 点击 `Execute`。
|
||
6. 查看 Response body。
|
||
|
||
如果这里能返回数据，但前端项目库加载失败，那问题多半在前端 API 地址、CORS、字段映射或浏览器网络请求。
|
||
|
||
## 另一个机器可读入口
|
||
|
||
OpenAPI JSON 在：
|
||
|
||
```text
|
||
http://localhost:8000/openapi.json
|
||
```
|
||
|
||
这是给工具读取的接口描述，Swagger UI 就是基于它渲染出来的。
|