OpenAPI Breaking Change Checker

Cómo usar esta herramienta para desarrolladores

1. Pega el documento JSON en el área de entrada o carga un archivo.
2. Revisa el formato y, cuando exista, selecciona la presentación del resultado.
3. Pulsa Comparar contratos o usa Ctrl/Cmd + Enter.
4. Comprueba el resumen, las métricas y la interpretación antes de copiar o descargar.

Qué hace esta herramienta para desarrolladores

Compara dos documentos OpenAPI JSON y detecta cambios incompatibles comunes en rutas, métodos, parámetros y respuestas. El resultado se calcula a partir de la estructura real del documento y no de una simple búsqueda de texto.

La herramienta no ejecuta llamadas HTTP ni valida el comportamiento real de un servidor. Utiliza el resultado como apoyo para revisar el contrato.

Ejemplo

El resultado depende de la operación; el ejemplo incluido en el botón «Ejemplo» reproduce un caso válido para esta herramienta.

{"openapi":"3.0.3","paths":{"/pets":{"get":{"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not found"}}}}}}
---COMPARE---
{"openapi":"3.0.3","paths":{"/pets":{"get":{"parameters":[{"name":"limit","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"}}}}}}

Casos de uso

• Revisión de contratos antes de publicar una API.
• Preparación de documentación y pruebas.
• Diagnóstico durante migraciones de versiones OpenAPI.
• Apoyo a generación de clientes, mocks y SDK.

Consejos para obtener resultados fiables

• Valida primero la sintaxis JSON.
• Conserva una copia del contrato original antes de convertirlo.
• Revisa referencias $ref y componentes compartidos.
• No interpretes una conversión parcial como certificación de compatibilidad.
• Prueba el resultado con tu validador OpenAPI habitual.

Detalles del procesamiento

El código recorre únicamente las estructuras necesarias para esta función y evita solicitudes de red. Las salidas descargables se generan desde el contenido calculado en la página.

No se resuelven referencias remotas y no se implementa un parser YAML. Las extensiones x-* y combinaciones avanzadas de JSON Schema pueden requerir comprobación adicional.