DiagramPreview
Aperçu avancéLive previewBrowser workflowExport SVG

Diagramme de flux d’erreurs API

Transformez les codes d’état API, conditions d’échec, règles de retry et actions de récupération en diagramme pour documentation API, runbooks et revues d’intégration.

Exemples
AperçuPrêt
Le résultat généré apparaîtra ici.

Continuer avec un outil lié

Envoyez cette prévisualisation vers un workflow proche pour convertir, déboguer ou exporter.

API debugging workflowopenapi-to-sequencepostman-collection-sequence-diagramhar-file-sequence-diagramapi-error-flow-diagram
OpenAPI vers diagramme de séquence

OpenAPI vers diagramme de séquence pour prévisualisation, review et export dans la documentation développeur.

Ouvrir
Postman Collection vers séquence

Postman Collection vers séquence pour prévisualisation, review et export dans la documentation développeur.

Ouvrir
HAR vers diagramme de séquence

HAR vers diagramme de séquence pour prévisualisation, review et export dans la documentation développeur.

Ouvrir

Comment utiliser

  1. 1Collez des lignes d’erreur avec code d’état, condition d’échec et action de récupération.
  2. 2Vérifiez le flux généré et séparez erreurs utilisateur, authentification, conflits, rate limits et erreurs serveur.
  3. 3Ajoutez codes applicatifs, règles de retry, Retry-After et actions d’observabilité.
  4. 4Exportez le diagramme pour documentation API, runbooks, notes SDK ou revues d’architecture.

Cas d’usage

Documentation d’erreurs APIArbres de décision de statutsRunbooks de retry et fallbackRevues d’intégration clientFlux de réponse incident

Outils associés

OpenAPI vers diagramme de séquence

OpenAPI vers diagramme de séquence pour prévisualisation, review et export dans la documentation développeur.

Postman Collection vers séquence

Postman Collection vers séquence pour prévisualisation, review et export dans la documentation développeur.

HAR vers diagramme de séquence

HAR vers diagramme de séquence pour prévisualisation, review et export dans la documentation développeur.

FAQ

Comment créer un diagramme d’erreurs API ?

Listez chaque code d’état avec la condition d’échec et l’action attendue, puis prévisualisez le flux. Séparez validation, authentification, conflits, rate limits et erreurs serveur.

Que doit contenir un flux d’erreurs API ?

Incluez codes HTTP, codes applicatifs stables, possibilité de retry, action visible par l’utilisateur, ainsi que logs, métriques ou alertes utiles pour l’investigation.

Puis-je documenter les règles de retry ?

Oui. Utilisez l’action pour préciser retry unique, backoff exponentiel, respect de Retry-After ou absence de retry si l’opération n’est pas idempotente.

Puis-je l’utiliser avec du contenu généré par IA ?

Oui. Utilisez l’IA pour le premier brouillon, puis prévisualisez et ajustez avant publication.

Quand est-ce mieux qu’une table de codes ?

La table sert de référence. Le diagramme est préférable pour revoir les branches, retries, fallbacks et passages vers la réponse opérationnelle.

Le diagramme d’erreurs API transforme une table de statuts en flux lisible pour documentation, SDK, support, runbooks et revues d’incident.

Utilisez-le pour distinguer validation, authentification, conflits, rate limits, dépendances en échec et erreurs serveur retryables.

Conservez les lignes source avec le diagramme exporté afin que les futures évolutions d’API restent faciles à relire et maintenir.

Démo : documenter les erreurs API en flux

La gestion des erreurs est plus facile à relire lorsque codes d’état, comportement client, règles de retry et récupération sont visibles dans un flowchart.

  • Séparez erreurs corrigeables par l’utilisateur, erreurs serveur et dépendances.
  • Marquez explicitement les réponses retryables.
  • Ajoutez les actions d’observabilité utiles aux incidents.
400 invalid input -> show field error
401 unauthorized -> refresh token
409 conflict -> reload cart
503 dependency timeout -> retry with backoff

Checklist : éviter les statuts ambigus

Un diagramme d’erreurs aide l’équipe à vérifier si le même code HTTP couvre trop de problèmes sans lien.

  • Vérifiez que chaque réponse possède un code et un message stables.
  • Documentez si le client peut relancer en sécurité.
  • Associez les erreurs opérationnelles aux logs, métriques et alertes.
HTTP 409
code: inventory_lock_conflict
client_action: reload inventory and retry once

Checklist de revue pour Diagramme de flux d’erreurs API

Utilisez Diagramme de flux d’erreurs API pour inspecter visuellement une source avant documentation, note de PR, post-mortem ou transfert. Transformez les codes d’état API, conditions d’échec, règles de retry et actions de récupération en diagramme clair.

Avant export, vérifiez la lisibilité, les relations, les données sensibles et la cohérence après modification.

Limites et dépannage

Si l'aperçu échoue, réduisez l'entrée au plus petit exemple complet, validez la syntaxe puis réajoutez les sections.

Considérez l'aperçu comme une surface de revue, pas comme une source de vérité. Les résultats critiques doivent être validés.

Exemples à tester

  • Checkout API: 400 | Invalid cart payload | Return validation details 401 | Missing access token | Ask client to authenticate 409 | Inventory changed | Refresh cart and retry 422 | Payment method...
  • Auth API: 400 | Password policy failed | Show policy requirements 401 | Wrong credentials | Return generic login error 403 | Account locked | Start recovery flow 429 | Too many attempts | Ap...
  • Rate limit: 429 | Request burst exceeded | Return Retry-After header 503 | Global throttle enabled | Route to degraded mode 500 | Quota store unavailable | Fail closed for write endpoints

Maturité de l'outil

Aperçu avancé

Analyse avancée

Cet outil extrait la structure et les relations depuis des entrées développeur. Les cas complexes doivent être vérifiés avec la source.

Le libellé indique si l'outil convient surtout à l'export stable, au débogage, à l'analyse rapide ou à la génération AI.