DiagramPreview
Vista avanzadaLive previewBrowser workflowExport SVG

Diagrama de Flujo de Errores API

Convierte códigos de estado API, condiciones de fallo, reglas de reintento y acciones de recuperación en un diagrama para documentación, runbooks y revisiones de integración.

Ejemplos
Vista previaListo
El resultado generado aparecerá aquí.

Continúa con una herramienta relacionada

Lleva esta vista previa a un flujo cercano para convertir, depurar o exportar.

API debugging workflowopenapi-to-sequencepostman-collection-sequence-diagramhar-file-sequence-diagramapi-error-flow-diagram
OpenAPI a diagrama de secuencia

OpenAPI a diagrama de secuencia para vista previa, review y exportación en documentación de desarrollo.

Abrir
Postman Collection a secuencia

Postman Collection a secuencia para vista previa, review y exportación en documentación de desarrollo.

Abrir
HAR a diagrama de secuencia

HAR a diagrama de secuencia para vista previa, review y exportación en documentación de desarrollo.

Abrir

Cómo usar

  1. 1Pega filas de error con código de estado, condición de fallo y acción de recuperación.
  2. 2Revisa el flujo generado y separa errores corregibles por el usuario, autenticación, conflictos, límites de tasa y fallos del servidor.
  3. 3Ajusta códigos de error, reglas de reintento, Retry-After y acciones de observabilidad.
  4. 4Exporta el diagrama para documentación API, runbooks, notas de SDK o revisiones de arquitectura.

Casos de uso

Documentación de errores APIÁrboles de decisión de estadosRunbooks de reintento y fallbackRevisiones de integración clienteFlujos de respuesta a incidentes

Herramientas relacionadas

OpenAPI a diagrama de secuencia

OpenAPI a diagrama de secuencia para vista previa, review y exportación en documentación de desarrollo.

Postman Collection a secuencia

Postman Collection a secuencia para vista previa, review y exportación en documentación de desarrollo.

HAR a diagrama de secuencia

HAR a diagrama de secuencia para vista previa, review y exportación en documentación de desarrollo.

FAQ

¿Cómo creo un diagrama de errores API?

Enumera cada código de estado con la condición de fallo y la acción esperada. Después revisa el flujo y separa validación, autenticación, conflictos, límites de tasa y fallos del servidor.

¿Qué debe incluir un flujo de errores API?

Incluye códigos HTTP, códigos de error estables, si el cliente puede reintentar, la acción visible para el usuario y las métricas, logs o alertas necesarias para investigar.

¿Puedo documentar reglas de reintento?

Sí. Usa la acción para indicar reintento único, backoff exponencial, respetar Retry-After o no reintentar cuando la operación no es idempotente.

¿Puedo usarlo con contenido generado por IA?

Sí. Usa IA para el primer borrador, luego previsualiza y ajusta antes de publicarlo en la documentación.

¿Cuándo es mejor que una tabla de estados?

La tabla sirve como referencia. El diagrama es mejor cuando el equipo necesita revisar ramas, reintentos, fallback y cuándo una incidencia pasa de cliente a operación.

El diagrama de errores API convierte tablas de estados en un flujo legible para documentación, SDKs, soporte, runbooks y revisiones de incidentes.

Úsalo para separar errores de validación, autenticación, conflictos, límites de tasa, dependencias y errores reintentables del servidor.

Conserva las filas fuente junto al diagrama exportado para que los cambios futuros de la API sean fáciles de revisar y mantener.

Demo: documentar errores API como flujo

El manejo de errores es más fácil de revisar cuando códigos de estado, comportamiento del cliente, reglas de reintento y recuperación aparecen en un flujo.

  • Separa errores corregibles por el usuario de fallos del servidor o dependencias.
  • Marca explícitamente las respuestas que admiten reintento.
  • Incluye acciones de observabilidad para incidentes.
400 invalid input -> show field error
401 unauthorized -> refresh token
409 conflict -> reload cart
503 dependency timeout -> retry with backoff

Checklist: evita estados ambiguos

Un diagrama de errores ayuda al equipo a decidir si el mismo estado HTTP está representando demasiados problemas no relacionados.

  • Comprueba que cada respuesta tenga código y mensaje estables.
  • Documenta si el cliente puede reintentar de forma segura.
  • Mapea errores operativos a logs, métricas y alertas.
HTTP 409
code: inventory_lock_conflict
client_action: reload inventory and retry once

Checklist de revisión para Diagrama de Flujo de Errores API

Usa Diagrama de Flujo de Errores API para inspeccionar visualmente contenido fuente antes de publicar documentación, notas de PR, incidentes o handoffs. Convierte códigos de estado, condiciones de fallo, reglas de reintento y acciones de recuperación en un diagrama de errores API.

Antes de exportar, revisa legibilidad, relaciones, datos sensibles y si la vista sigue teniendo sentido tras editar la entrada.

Límites y solución de problemas

Si la vista falla, reduce la entrada al ejemplo completo más pequeño, valida la sintaxis y agrega secciones gradualmente.

Trata la vista como superficie de revisión, no como fuente de verdad. Los resultados críticos requieren validación humana.

Entradas de ejemplo

  • 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

Madurez de la herramienta

Vista avanzada

Analizador avanzado

Esta herramienta extrae estructura y relaciones de entradas de desarrollo. Los casos complejos deben comprobarse contra la fuente.

La etiqueta indica si la herramienta sirve mejor para exportar, depurar, analizar rápido o generar con AI.