Как определить параметры запроса, используя модель Pydantic в FastAPI?

Чтобы создать модель Pydantic и использовать ее для определения параметров запроса, вам нужно будет использовать Depends() в параметре вашей конечной точки. Чтобы добавить description, title и т. д. для параметров запроса, вы можете обернуть Query() в Field().

Я также хотел бы отметить, что вместо Literal можно использовать тип Enum, как описано здесь и здесь . Кроме того, если кто-то хочет определить поле List внутри модели Pydantic и использовать его в качестве параметра запроса, ему нужно будет либо реализовать это в отдельном классе зависимостей, как показано здесь и здесь, либо снова заверните Query() в Field(), как показано ниже.

Более того, чтобы выполнить проверку параметров запроса внутри модели Pydnatic, можно сделать это, как обычно, используя Pydantic @validator , как показано здесь , а также здесь и здесь . Обратите внимание, что в этом случае, когда BaseModel используется для параметров запроса, повышение ValueError вызовет Internal Server Error. Следовательно, вы должны вместо этого вызвать HTTPException , когда проверка не удалась, или использовать собственный обработчик исключений для обработки ValueError исключений, как показано в Варианте 2 этого ответа . Помимо @validator, можно также иметь дополнительные проверки для Query параметров, как описано в документации FastAPI (см. также Реализация класса запроса).

В качестве примечания, касающегося определения необязательных параметров, в приведенном ниже примере используется подсказка типа Необязательный (сопровождаемый None в качестве значения по умолчанию в Query) из модуля typing ; однако вы также можете взглянуть на этот ответ и этот ответ, в которых описаны все доступные способы, как это сделать.

Рабочий пример

from fastapi import FastAPI, Depends, Query, HTTPException
from pydantic import BaseModel, Field, validator
from typing import List, Optional, Literal
from enum import Enum

app = FastAPI()

class Status(str, Enum):
    new = 'New'
    old = 'Old'


class ServiceStatus(BaseModel):
    status: Optional[Status] = Field (Query(..., description='Select service status'))
    msg: Optional[str] = Field (Query(None, description='Type something'))
    choice: Literal['a', 'b', 'c', 'd'] = Field (Query(..., description='Choose something'))
    comments: List[str] = Field (Query(..., description='Add some comments'))
    
    @validator('choice')
    def check_choice(cls, v):
        if v == 'b': 
             raise HTTPException(status_code=422, detail='Wrong choice')
        return v

@app.get('/status')
def main(status: ServiceStatus = Depends()):
    return status