docs(private-api): add docs for private-api

This commit is contained in:
MingxuanGame
2025-08-12 10:21:26 +00:00
parent b09960af4c
commit 147509a93c
6 changed files with 106 additions and 28 deletions

View File

@@ -39,11 +39,18 @@ async def lifespan(app: FastAPI):
await redis_client.aclose()
desc = (
"osu! API 模拟服务器,支持 osu! API v2 和 osu!lazer 的绝大部分功能。\n\n"
"官方文档:[osu!web 文档](https://osu.ppy.sh/docs/index.html)"
)
if settings.debug:
desc += "\n\n私有 API 签名机制:[GitHub](https://github.com/GooGuTeam/osu_lazer_api/wiki/%E7%A7%81%E6%9C%89-API-%E7%AD%BE%E5%90%8D%E9%AA%8C%E8%AF%81%E6%9C%BA%E5%88%B6)"
app = FastAPI(
title="osu! API 模拟服务器",
version="1.0.0",
lifespan=lifespan,
summary="osu! API 模拟服务器,支持 osu! API v2 和 osu!lazer 的绝大部分功能。官方文档https://osu.ppy.sh/docs/index.html",
description=desc,
)
app.include_router(api_v2_router)