Блог

В документации предлагается создавать HttpException с ошибками клиента, что здорово. Но как я могу показать эти конкретные ошибки в документации, следуя модели HttpException? Имеется в виду dict с ключом «detail».

Следующее не работает, потому что HttpException не является моделью Pydantic.

 @app.get(
    '/test', 
    responses={
        409 : {
            'model' : HTTPException, 
            'description': 'This endpoint always raises an error'
        }
    }
)
def raises_error():
    raise HTTPException(409, detail='Error raised')
  

Да, это недопустимый тип Pydantic, однако, поскольку вы можете создавать свои собственные модели, для него легко создать модель.

 from fastapi import FastAPI
from fastapi.exceptions import HTTPException
from pydantic import BaseModel


class Dummy(BaseModel):
    name: str


class HTTPError(BaseModel):
    detail: str

    class Config:
        schema_extra = {
            "example": {"detail": "HTTPException raised."},
        }


app = FastAPI()


@app.get(
    "/test",
    responses={
        200: {"model": Dummy},
        409: {
            "model": HTTPError,
            "description": "This endpoint always raises an error",
        },
    },
)
def raises_error():
    raise HTTPException(409, detail="Error raised")
  

Я считаю, что это то, чего вы ожидаете