在swagger doc中使用Pyd的模型（FastAPI）设置查询参数的描述

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

它按预期工作，但描述（在模型中添加）没有反映在 Swagger UI 中

但是，如果请求正文使用相同的模型，则描述将以大摇大摆的方式显示

为了在swagger ui中获得对QueryParams(model)的描述，我是否遗漏了什么？

Answer 1

公认的答案是使用自定义依赖项，使用FastAPI类作为依赖项来批量定义查询参数，虽然我认为这样做很好，但我觉得在这种情况下使用dataclasses会更好，并减少代码重复，因为< code>__init__会自动生成。

作为依赖项的普通类

class QueryParams:
    def __init__(self, 
    x:  Query(
            None, description="Arg1", example=10),
    y:  Query(
            None, description="Arg2", example=20)
    ):
        self.x = x
        self.y = y

虽然对于较少数量的查询参数，这样做很好，但如果参数数量像我的一个apiendpoint那样多，这很快就会变得麻烦。

使用数据类作为依赖项

@dataclass
class QueryParams:
    x:  Query(None, description="Arg1", example=10)
    y:  Query(None, description="Arg2", example=20)

此外，如果您需要更复杂的功能，您还将添加数据类的好东西。

Answer 2

这对我有用

from fastapi import Depends, FastAPI, Query

@app.post("/route")
def some_api(
        self,
        query_param_1: float = Query(None, description="description goes here", ),
        query_param_2: float = Query(None, description="Param 2 does xyz"),
):
    
return "hello world"

Answer 3

这在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

因此，您将拥有文档作为，

< li >在FastAPI中验证GET参数- (FastAPI GitHub)似乎对扩展Pydantic模型来验证GET参数不太感兴趣 < li >作为依赖项的类- (FastAPI Doc)