FastAPI에서 오류 응답을 사용자 정의하는 방법은 무엇입니까?

FastAPI에서 오류 응답 사용자 정의

잘못된 JSON 요청을 받으면 FastAPI는 일반적으로 문제에 대한 자세한 정보와 함께 422 처리할 수 없는 엔터티 오류를 반환합니다. 그러나 자신만의 메시지와 구조로 이 오류 응답을 사용자 정의할 수 있습니다.

이를 처리하는 한 가지 방법은 기본 요청 유효성 검사 예외 핸들러를 재정의하는 것입니다. 이는 사용자 정의 예외 처리기 데코레이터를 구현하여 수행할 수 있습니다. 다음은 사용자 정의 메시지를 포함하도록 오류 응답을 수정하는 예입니다.

<code class="python">from fastapi import FastAPI, Body, Request, status
from fastapi.encoders import jsonable_encoder
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    return JSONResponse(
        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
        content=jsonable_encoder({
            "detail": exc.errors(),  # optionally include the errors
            "body": exc.body,
            "custom msg": {"Your error message"}
        }),
    )

class Demo(BaseModel):
    content: str = None

@app.post("/demo")
async def demo_func(d: Demo):
    return d.content</code>

이 예외 핸들러는 원래 유효성 검사 오류 및 요청 본문과 함께 사용자 정의 메시지가 포함된 JSON 응답을 반환합니다.

또는 오류 응답을 일반 텍스트 메시지로 사용자 정의할 수 있습니다.

<code class="python">from fastapi.responses import PlainTextResponse

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request, exc):
    return PlainTextResponse(str(exc), status_code=422) </code>

이 핸들러는 오류 메시지를 나타내는 간단한 일반 텍스트 문자열을 출력합니다. 이 두 가지 방법을 모두 사용하면 오류 응답을 사용자 정의하여 API 사용자에게 보다 사용자 친화적이거나 상황에 맞는 메시지를 제공할 수 있습니다.

위 내용은 FastAPI에서 오류 응답을 사용자 정의하는 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!