Contratos API

comparar especificaciones OpenAPIRevisa el impacto antes de publicar

Pega el contrato anterior y el nuevo; ejecuta la comparación cuando estén listos.

comparar especificaciones OpenAPI

Especificación anterior

Especificación nueva

Informe de cambios

Ambas especificaciones se procesan en este navegador; no se envían peticiones API.

Opciones de comparación

Alcance: operaciones, parámetros, cuerpos de solicitud y respuestas rastreados. No prueba compatibilidad real.

Pega las dos especificaciones para comparar.

Comparar especificaciones OpenAPI sirve cuando una versión nueva cambia el contrato que ya usan otras aplicaciones. Un diff de texto no explica por sí solo si borrar una ruta o exigir un parámetro rompe una llamada anterior.

Este diff de OpenAPI separa cambios incompatibles en la API de los que requieren revisión. El comparador OpenAPI no presenta un cambio incierto como garantía de compatibilidad.

Por qué comparar especificaciones OpenAPI

Prioriza el contrato de los clientes actuales

Al comparar especificaciones OpenAPI, la dirección importa: del documento anterior al nuevo. Un campo de respuesta eliminado y una ruta añadida aparecen en categorías distintas.

Dos documentos de contrato desembocan en un informe con un campo de respuesta eliminado y una ruta nueva separados.

Deja visibles las exclusiones

Un path exacto se excluye en ambos documentos y queda registrado en el informe. El equipo puede comprobar el alcance sin interpretar comodines.

Un filtro de ruta exacta aparta una tarjeta de endpoint y la conserva en el registro de exclusiones.

Tres decisiones para interpretar el resultado

01

Confirma qué versión es anterior

El análisis toma la perspectiva de quien usa el contrato viejo. Intercambiar abre una vista previa y permite deshacer una vez junto con el resultado anterior.

02

Escribe rutas completas

Cada línea, como /internal/health, debe coincidir con una clave path de OpenAPI. No se interpreta como regex ni JSON Pointer; al editarla hay que volver a comparar.

03

Filtra sin perder el informe

La categoría seleccionada solo cambia la lista visible. JSON y Markdown conservan todos los hallazgos de la ejecución vigente.

Cambios que se pueden rastrear

Rutas y métodos

Eliminar una operación existente se marca como riesgo de ruptura; agregar una nueva aparece aparte. Así los cambios disruptivos no quedan ocultos entre líneas de texto.

Parámetros y respuestas

Se detectan entradas nuevas obligatorias, respuestas retiradas y propiedades de respuesta perdidas. También se revisan tipos y enum sencillos con referencias locales resueltas.

Informe con evidencia

Cada hallazgo incluye método, ruta, regla y valores antes/después. El informe íntegro puede copiarse o descargarse cuando el análisis está completo.

Límites de esta revisión estática

Sin obtener URL externas
Solo se procesa JSON o YAML pegado. No se descarga una especificación desde una URL ni se llama a la API de destino.
Exclusiones exactas
No se admiten comodines, expresiones regulares ni rutas callback para ignorar operaciones.
Referencias incompletas bloquean
Los $ref externos, dialectos no cubiertos, webhooks y callbacks impiden exportar un informe de riesgo completo.
No certifica el comportamiento real
El contrato no demuestra cómo actúan servidores, clientes o SDK generados. Comprueba los consumidores antes de publicar.

Preguntas sobre comparar especificaciones OpenAPI

¿Qué formatos de esquema soporta la herramienta?

Se admiten Swagger 2.0 y OpenAPI 3.0/3.1 en JSON o YAML. GraphQL y colecciones Postman quedan fuera de este comparador.

¿Cómo identifica los cambios incompatibles?

Las rutas retiradas, los nuevos datos obligatorios y respuestas esperadas que desaparecen son candidatos a incompatibilidad. Cada uno muestra la regla y el elemento afectado.

¿Qué significa el "riesgo de publicación" en el resultado?

No es una predicción de despliegue. La categoría indica el riesgo del contrato: ruptura potencial, cambio a revisar o adición compatible; el comportamiento real requiere pruebas.

¿Es posible comparar sin especificar el tipo de esquema?

Sí. El analizador detecta JSON o YAML por el texto, sin selector de formato. Los errores de sintaxis muestran el lado y la ubicación disponible.

¿El informe detalla el impacto específico por cambio?

El informe detalla método, ruta, categoría, regla, puntero y valores anteriores y nuevos. Comparar especificaciones OpenAPI no sustituye pruebas de consumidores.

¿Te resultó útil la comparación?

Empieza a comparar especificaciones OpenAPI

Comparar especificaciones OpenAPI entrega evidencias para revisar una versión. Contrasta los riesgos con tus clientes antes de lanzarla.