python - 使用 Pydantic 模型 (FastAPI) 在 swagger 文档中设置查询参数的描述

Question

这是继续这个question .
我添加了一个模型来获取 pydantic 模型的查询参数

class QueryParams(BaseModel):
    x: str = Field(description="query x")
    y: str = Field(description="query y")
    z: str = Field(description="query z")


@app.get("/test-query-url/{test_id}")
async def get_by_query(test_id: int, query_params: QueryParams = Depends()):
    print(test_id)
    print(query_params.dict(by_alias=True))
    return True

它按预期工作，但描述(在模型中添加)没有反射(reflect)在 swagger ui 中

但是如果请求正文使用相同的模型，那么描述会以swagger的形式显示

我是否缺少任何内容来获取 swagger ui 中 QueryParams(model) 的描述？

Answer 1

这对于 Pydantic 模型是不可能的
获得所需结果的解决方法是使用 自定义依赖类(或函数)而不是 Pydantic 模型

from fastapi import Depends, FastAPI, Query

app = FastAPI()


class CustomQueryParams:
 def __init__(
 self,
 foo: str = Query(..., description="Cool Description for foo"),
 bar: str = Query(..., description="Cool Description for bar"),
 ):
 self.foo = foo
 self.bar = bar


@app.get("/test-query/")
async def get_by_query(params: CustomQueryParams = Depends()):
    return params

因此，您将拥有该文档，


引用

Validate GET parameters in FastAPI--(FastAPI GitHub)似乎对扩展 Pydantic 模型以验证 GET 参数的兴趣不大

Classes as Dependencies--(FastAPI Doc)