fix: docs 分组与 summary 统一 + 记事本页加「复制链接」按钮
docs 乱:
- main.py 页面路由(/upload /files /wb-admin /wb/{id} /docs /redoc / /health)
加 tags(pages/docs/meta)+ summary/description,Swagger UI 按 tag 分组显示。
- whiteboard_controller 残留「白板/笔画/修改次数」改为「记事本/文本/编辑次数」。
复制链接:
- 记事本页加「复制链接」按钮,复制 {origin}/wb/{id} 分享链接(保留「复制文本」)。
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
"""白板接口:REST(访问/管理)+ WebSocket(实时同步)。
|
||||
|
||||
路由:
|
||||
GET /api/wb/{board_id} 公开:访问白板元数据,不存在则新建(前端 init 用)
|
||||
GET /api/wb/{board_id} 公开:访问记事本元数据,不存在则新建(前端 init 用)
|
||||
WS /ws/wb/{board_id} 公开:实时协作 + 心跳
|
||||
GET /api/admin/wb Basic Auth:管理页列表
|
||||
DELETE /api/admin/wb/{board_id} Basic Auth:删除白板
|
||||
DELETE /api/admin/wb/{board_id} Basic Auth:删除记事本
|
||||
|
||||
HTML 页面 /wb/{id} 与管理页 /wb-admin 由 main.py 直接返回静态文件,
|
||||
不在此 controller 注册,避免与 REST 同路径冲突。
|
||||
@@ -41,8 +41,8 @@ def _service(db: Session = Depends(get_db)) -> WhiteboardService:
|
||||
@router.get(
|
||||
"/api/wb/{board_id}",
|
||||
response_model=WhiteboardOut,
|
||||
summary="访问白板元数据(不存在则新建)",
|
||||
description="前端打开 /wb/{id} 页面后调本接口拉取初始笔画;不存在时自动创建空板。",
|
||||
summary="访问记事本元数据(不存在则新建)",
|
||||
description="前端打开 /wb/{id} 页面后调本接口拉取初始文本;不存在时自动创建空板。",
|
||||
)
|
||||
def get_whiteboard(board_id: str, service: WhiteboardService = Depends(_service)) -> WhiteboardOut:
|
||||
return service.get_or_create(board_id)
|
||||
@@ -53,8 +53,8 @@ def get_whiteboard(board_id: str, service: WhiteboardService = Depends(_service)
|
||||
@router.get(
|
||||
"/api/admin/wb",
|
||||
response_model=WhiteboardListResponse,
|
||||
summary="列出所有白板(需鉴权)",
|
||||
description="供白板管理页使用:board_id / 创建时间 / 修改次数 / 上次修改时间。",
|
||||
summary="列出所有记事本(需鉴权)",
|
||||
description="供记事本管理页使用:board_id / 创建时间 / 编辑次数 / 上次修改时间。",
|
||||
)
|
||||
def list_whiteboards(
|
||||
limit: int = Query(100, ge=1, le=500),
|
||||
@@ -68,7 +68,7 @@ def list_whiteboards(
|
||||
|
||||
@router.delete(
|
||||
"/api/admin/wb/{board_id}",
|
||||
summary="删除白板(需鉴权)",
|
||||
summary="删除记事本(需鉴权)",
|
||||
description="删 DB 行,并关闭该 board 的所有在线 WebSocket 连接。",
|
||||
)
|
||||
def delete_whiteboard(
|
||||
|
||||
Reference in New Issue
Block a user