Aller au contenu principal

Gestion d'erreur

Une erreur est une réponse comme les autres.

De manière à simplifier la gestion des cas d'erreurs par le consommateur, la meilleure approche consiste à :

  1. Choisir le bon code statut adapté à la situation
  2. Fournir une réponse (body), le code statut étant la première information à vérifier côté client, elle s'avère souvent insuffisante :
    • avec un code applicatif interprétable de manière programmatique (et documenté)
    • avec un message à destination de l'utilisateur final (dans l'idéal I18N compliant)
    • éventuellement des informations supplémentaires sur l'origine ou les conditions de l'erreur, dans un attribut extra
doitToutes les erreurs doivent présenter une réponse JSON et respecter le même schéma.

Exemple pour un code statut 400 :

{
"code": "BAD_REQUEST",
"message": "Mauvais format",
"extra": {
"fieldName": "date",
"value": "5/13/9",
"expectedFormat": "[0-9]{2}/[0-9]{2}/[0-9]{4}"
}
}