FastAPIで意図しないエラーが発生したときにExceptionでハンドリングしていましたが、それだけではpydanticで発生するエラーがキャッチできなかったのでメモします。

なお、pydanticはAPIのRequestとResponseのモデルで使用していますので、フロントのバリデーションエラーと考えてください。

環境

Python
- 3.11
FastAPI
- 0.105.0
pydantic
- 2.5.3

ゴール

pydanticで発生していた次の詳細すぎるメッセージが返却されないこと。

{
  "detail": [
    {
      "type": "greater_than_equal",
      "loc": [
        "body",
        "age"
      ],
      "msg": "Input should be greater than or equal to 18",
      "input": 0,
      "ctx": {
        "ge": 18
      },
      "url": "https://errors.pydantic.dev/2.5/v/greater_than_equal"
    }
  ]
}

実装

Exceptionだけでなく、FastAPIのRequestValidaionErrorもException_handlerに追加する必要があります。

# 全てのエラーをキャッチするハンドラ
# ただし、これだけではキャッチできないエラーも存在する
@app.exception_handler(Exception)
async def unhandled_exception_handler(request: Request, exc: Exception):
    return JSONResponse(
        status_code=500,
        content={"detail": f"SystemError"},
    )

# 追記したハンドラ
# pydanticのエラーをFastAPIでラップしたRequestValidationErrorを使用します。
@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    return JSONResponse(
        status_code=400,
        content={"detail": f"BadRequest"},
    )