docs(chat): add API docs

This commit is contained in:
MingxuanGame
2025-08-16 15:35:27 +00:00
parent 4eace3f84e
commit 87a3928e20
4 changed files with 117 additions and 30 deletions

View File

@@ -11,8 +11,15 @@ from fastapi import Query
__all__ = ["chat_router"]
@router.get("/notifications")
async def get_notifications(max_id: int | None = Query(None)):
@router.get(
"/notifications",
tags=["通知", "聊天"],
name="获取通知",
description="获取当前用户未读通知。根据 ID 排序。同时返回通知服务器入口。",
)
async def get_notifications(
max_id: int | None = Query(None, description="获取 ID 小于此值的通知"),
):
if settings.server_url is not None:
notification_endpoint = f"{settings.server_url}notification-server".replace(
"http://", "ws://"