#305 · Herramienta para desarrolladores

API Error Catalog Builder

Construye un catálogo uniforme a partir de errores de API expresados como JSON. Acepta un array de objetos o un objeto contenedor con una propiedad `errors`, y busca campos habituales como `code`, `status`, `message`, `description` o `detail`. El resultado agrupa los datos en una tabla Markdown y señala códigos duplicados o registros incompletos. Así puedes transformar muestras dispersas de errores en una referencia técnica más fácil de revisar antes de incorporarla a documentación o pruebas.

Datos de entrada

Errores API en JSON
Espacio publicitario

Cómo usar esta herramienta para desarrolladores

  1. Pega un array JSON de errores o un objeto con `errors`.
  2. Incluye, cuando existan, código interno, estado HTTP, mensaje y detalle.
  3. Genera el catálogo y revisa duplicados e incompletos.
  4. Copia el Markdown o exporta CSV/JSON para mantener la referencia.

Qué hace esta herramienta para desarrolladores

Normaliza muestras de error heterogéneas en un catálogo con columnas consistentes y métricas de calidad básica.

Reconoce varios nombres de campo habituales para código y estado; después crea una fila por error y comprueba duplicados de código.

La herramienta no decide qué código HTTP es correcto para cada caso ni verifica que los errores coincidan con la implementación del servidor.

Ejemplo

Entrada

[{"code":"USER_NOT_FOUND","status":404,"message":"Usuario no encontrado","description":"El identificador no existe"},{"code":"VALIDATION_FAILED","status":422,"message":"Datos inválidos"}]

Salida esperada

| Código | HTTP | Mensaje | Descripción |
|---|---:|---|---|
| USER_NOT_FOUND | 404 | Usuario no encontrado | El identificador no existe |
| VALIDATION_FAILED | 422 | Datos inválidos | — |

Casos de uso

  • Crear una sección de errores para documentación API.
  • Consolidar muestras de respuestas de distintos endpoints.
  • Detectar códigos internos duplicados antes de publicar una referencia.
  • Preparar datos de error para QA, soporte o tests automatizados.

Consejos para obtener resultados fiables

  • Usa códigos de error estables, no solo mensajes humanos.
  • Mantén separado el código interno del estado HTTP.
  • Evita exponer trazas, IDs sensibles o información interna en mensajes públicos.
  • Revisa manualmente los registros incompletos señalados.
  • Versiona el catálogo junto a los cambios del contrato API.

Detalles del procesamiento

El normalizador acepta aliases frecuentes (`statusCode`, `httpStatus`, `errorCode`, `detail`) para reducir trabajo al recopilar muestras de distintas fuentes.

No deduce taxonomías, severidad ni remediación. Un catálogo completo debe contrastarse con el código y la especificación oficial de la API.

Preguntas frecuentes

¿Qué estructura JSON admite el constructor de catálogo de errores?

Puede recibir directamente un array de objetos o un objeto que contenga un array en la propiedad `errors`.

¿Qué campos usa para identificar el código y el estado HTTP?

Busca `code`, `errorCode` o `type` para el código, y `status`, `statusCode` o `httpStatus` para el estado.

¿Cómo detecta códigos de error duplicados?

Compara el valor normalizado del código en todas las entradas y contabiliza cada repetición posterior.

¿Puede decidir si debo usar 400, 404 o 422?

No. Esa decisión depende del contrato de tu API; la herramienta solo organiza los valores proporcionados.

¿Es seguro pegar respuestas de error de producción?

Hazlo solo después de retirar tokens, datos personales, trazas internas y cualquier información sensible.

Módulos de la herramienta

MóduloComportamiento
NormalizaciónAcepta aliases comunes de código, estado y detalle.
Control de duplicadosCuenta códigos repetidos.
Catálogo MarkdownGenera una tabla apta para documentación.

Explorar la categoría

Consulta más utilidades de API y GraphQL en el hub de la categoría.

Ver API y GraphQL