Maison >développement back-end >Tutoriel Python >Comment personnaliser les réponses d'erreur pour les requêtes JSON invalides dans FastAPI ?

Comment personnaliser les réponses d'erreur pour les requêtes JSON invalides dans FastAPI ?

Susan Sarandon
Susan Sarandonoriginal
2024-10-21 06:28:30838parcourir

How to Customize Error Responses for Invalid JSON Requests in FastAPI?

Personnalisation de la gestion des erreurs dans FastAPI

Question :

Lors de l'envoi d'une requête JSON non valide à un backend FastAPI, une erreur est générée avec un code d'état d'entité non traitable (422). La réponse inclut des détails d’erreur détaillés qui ne sont pas idéaux pour une gestion conviviale des erreurs. Existe-t-il un moyen de personnaliser la réponse d'erreur ?

Réponse :

Pour gérer cette situation et personnaliser la réponse d'erreur, vous pouvez remplacer le gestionnaire d'exceptions de validation de demande dans FastAPI . Voici comment l'implémenter :

Tout d'abord, n'oubliez pas que vous transmettez un JSON non valide et, par conséquent, le serveur répond correctement avec l'erreur 422 Unprocessable Entity.

Remplacement du gestionnaire d'exceptions :

  1. Dans votre application FastAPI, ajoutez le code suivant pour remplacer le gestionnaire d'exceptions par défaut pour RequestValidationError :
<code class="python">@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"}
        }),
    )</code>
  1. Dans le code ci-dessus , vous pouvez personnaliser le message d'erreur en modifiant la valeur de "custom msg".

Renvoyer une PlainTextResponse :

Alternativement, vous pouvez également renvoyer une réponse personnalisée message d'erreur utilisant un PlainTextResponse :

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

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn