Wie kann ich Fehlerantworten für ungültige Anfragen in FastAPI anpassen?

Benutzerdefinierte Fehlerreaktionsbehandlung in FastAPI

In FastAPI-Anwendungen ist die Fehlerbehandlung unerlässlich, um den Kunden informative Antworten zu geben. Ein häufiges Problem besteht darin, dass beim Senden zusätzlicher oder ungültiger Daten in Anfragen der Fehler 422 Unprocessable Entity angezeigt wird. In diesem Artikel wird gezeigt, wie Sie die Fehlerreaktion anpassen, um solche Szenarien zu bewältigen.

Betrachten Sie das folgende FastAPI-Backend-Beispiel:

from fastapi import FastAPI

app = FastAPI

class Demo(BaseModel):
    content: str = None

@app.post("/demo")
async def demoFunc(d: Demo):
    return d.content

Beim Senden einer Anfrage mit zusätzlichen Daten, wie z. B. data = { „content“: „some text here“}aaaa, die API gibt einen 422-Fehler mit der folgenden Antwort zurück:

{
  "detail": [
    {
      "loc": [
        "body",
        47
      ],
      "msg": "Extra data: line 4 column 2 (char 47)",
      "type": "value_error.jsondecode",
      "ctx": {
        "msg": "Extra data",
        "doc": "{\n  \"content\": \"some text here\"}aaaaa",
        "pos": 47,
        "lineno": 4,
        "colno": 2
      }
    }
  ]
}

Um die Fehlerantwort anzupassen, ermöglicht FastAPI das Überschreiben des Ausnahmehandlers für die Anforderungsvalidierung. Beginnen Sie mit dem Importieren der erforderlichen Module und der Definition einer benutzerdefinierten Ausnahmehandlerfunktion:

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(),
            "body": exc.body,
            "custom msg": {
                "Your error message"
            }
        }),
    )

Diese Funktion fängt die RequestValidationError-Ausnahme ab und generiert eine benutzerdefinierte JSON-Antwort. Sie können die Fehlerdetails, den Anforderungstext und jede benutzerdefinierte Nachricht einschließen.

Beispielsweise würde die Verwendung eines ungültigen JSON-Textes jetzt zu einer Antwort ähnlich der folgenden führen:

{
    "detail": [
        {
            "loc": ["body", 1],
            "msg": "invalid json",
            "type": "json.decoder.JSONDecodeError",
            "ctx": {}
        }
    ],
    "body": {},
    "custom msg": {
        "Your error message"
    }
}

Alternativ: Sie können eine Nur-Text-Antwort nur mit der Fehlermeldung zurückgeben:

from fastapi.responses import PlainTextResponse

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

Durch die Anpassung des Fehlerantwortverhaltens in FastAPI können Sie eine informativere und konsistentere Fehlerbehandlung für Ihre APIs bereitstellen. Dies verbessert die Benutzererfahrung und vereinfacht das Debuggen sowohl für Entwickler als auch für API-Konsumenten.

Das obige ist der detaillierte Inhalt vonWie kann ich Fehlerantworten für ungültige Anfragen in FastAPI anpassen?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!