Rendez vos devs front heureux en normalisant toutes vos erreurs d'API
Présentation par Clément Herreman sur la normalisation des erreurs d'API pour améliorer l'expérience développeur frontend à l'API Platform Conference 2025
Cette sketchnote a été réalisée lors de l'API Platform Conference 2025. Elle illustre la présentation "Rendez vos devs front heureux en normalisant toutes vos erreurs d'API" donnée par Clément Herreman, qui propose une approche structurée de la gestion des erreurs d'API.
Contenu de la présentation
Le concept fondamental : une erreur = comportement inattendu. L'objectif (symbolisé par une cible) est double : expliquer pourquoi ça marche pas et quoi faire pour résoudre le problème. Cela inclut l'identification des problèmes et la mise en place de mécanismes de retry / mécanisme continu.
La section "Comment ?" détaille la méthodologie en deux étapes :
Cataloguer les erreurs selon trois catégories :
- Ce qui peut arriver dans mon système : erreurs prévisibles et contrôlables (validation, business rules)
- Ce qui peut arriver hors de mon système : erreurs externes (services tiers, timeouts)
- Ce qui est rare et que je gère pas : erreurs exceptionnelles non gérées spécifiquement
Formater les erreurs en suivant les standards : migration de RFC 7807 vers RFC 9457 (Problem Details for HTTP APIs), assurant une structure cohérente et interopérable.
Le concept clé : dans API Platform l'erreur est comme un "ornithorynque", c'est-à-dire un assemblage de concepts hétérogènes : exception (technique), error (métier), et resource (API). Cette métaphore souligne la nature composite et parfois étrange des erreurs dans les APIs modernes.
L'idée : étendre l'assemblage pour notre domaine en ajoutant des metadata pour l'automatisation. Ces métadonnées permettent aux clients de l'API de gérer automatiquement certaines erreurs (retry automatique, affichage contextualisé, etc.).