如何使用FastApi依赖项向OpenAPI模式添加描述

Question

如果我使用依赖关系系统，有没有办法将字段描述添加到FastAPI swagger模式

在FastAPI docs的简单示例中，我看不到添加描述的地方

async def common_parameters(q: str = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit} 

Answer 1

您可以使用Query或Body添加描述，具体取决于您的用例

from typing import Optional

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/dummy")
async def dummy(q: Optional[str] = Query(None, description="My description")):
    ...

您可以添加更多元数据，请参见documentation