Detector de breaking changes API y planificador de migracion

Compara dos esquemas OpenAPI 3.x, detecta cambios incompatibles y propone estrategias de migracion

Ayuda a equipos API a medir impacto de eliminaciones, restricciones de tipos y cambios en campos requeridos.

Resultados de ejemplo

1 Ejemplos

Detectar breaking changes entre versiones de API

Compara dos esquemas OpenAPI e identifica cambios que pueden romper clientes existentes

Breaking changes are grouped by impact with migration strategies.
Ver parámetros de entrada
{ "oldSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: false\n content:\n application/json:\n schema:\n type: object\n properties:\n name: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n name: { type: string }\n", "newSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: true\n content:\n application/json:\n schema:\n type: object\n required: [name, role]\n properties:\n name: { type: string }\n role: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n" }

Datos clave

Categoría
Desarrollo y Web
Tipos de entrada
textarea
Tipo de salida
html
Cobertura de muestras
4
API disponible
Yes

Resumen

El Detector de breaking changes API y planificador de migración es una herramienta esencial para equipos de desarrollo que necesitan comparar dos esquemas OpenAPI 3.x. Al analizar las diferencias entre la versión anterior y la nueva, identifica automáticamente cambios incompatibles, como la eliminación de campos, restricciones de tipos de datos o la adición de parámetros obligatorios, generando un reporte claro con estrategias de migración para evitar interrupciones en los clientes existentes.

Cuándo usarlo

  • •Antes de lanzar una nueva versión de una API en producción para asegurar que no se rompan las integraciones de los clientes actuales.
  • •Durante la revisión de código (code review) para evaluar el impacto de las modificaciones propuestas en el contrato de la API.
  • •Al planificar la migración de consumidores de una API hacia una nueva versión que incluye cambios estructurales significativos.

Cómo funciona

  • •Pega el esquema OpenAPI 3.x original en el campo 'Schema OpenAPI anterior'.
  • •Introduce la nueva versión del contrato en el campo 'Schema OpenAPI nuevo'.
  • •La herramienta analiza ambos documentos y detecta diferencias estructurales, evaluando la compatibilidad hacia atrás.
  • •Revisa el reporte HTML generado, que agrupa los 'breaking changes' por nivel de impacto y sugiere estrategias de migración.

Casos de uso

Prevención de incidentes en producción al detectar campos eliminados o renombrados antes del despliegue.
Generación de guías de actualización (changelogs) precisas para los desarrolladores frontend o clientes externos que consumen la API.
Auditoría de contratos de API en arquitecturas de microservicios para garantizar la compatibilidad entre distintos equipos.

Ejemplos

1. Detección de nuevos campos obligatorios en el Request Body

Desarrollador Backend
Contexto
El equipo está actualizando el endpoint de creación de usuarios para requerir un rol específico por motivos de seguridad.
Problema
Necesitan confirmar si este cambio romperá las integraciones de los clientes móviles que actualmente no envían el campo 'role'.
Cómo usarlo
Pega el esquema anterior donde el requestBody es opcional y el nuevo esquema donde el requestBody es obligatorio y exige el campo 'role'.
Resultado
La herramienta alerta que hacer obligatorio el requestBody y añadir 'role' como requerido es un breaking change de alto impacto, sugiriendo mantener un valor por defecto temporalmente.

2. Identificación de campos eliminados en la respuesta

Arquitecto de Software
Contexto
Se está refactorizando la base de datos y un campo obsoleto ('name') ya no se devolverá en la respuesta del endpoint de usuarios.
Problema
Evaluar el impacto de dejar de enviar el campo 'name' en el JSON de respuesta para los consumidores actuales.
Cómo usarlo
Introduce el esquema original que incluye 'name' en las properties de la respuesta 200, y el nuevo esquema donde solo se devuelve el 'id'.
Resultado
El reporte HTML clasifica la eliminación del campo 'name' en la respuesta como un cambio incompatible y recomienda notificar a los consumidores o crear un endpoint v2 antes de la eliminación definitiva.

Probar con muestras

development
Colecciones Postman - Pruebas API
Ejemplos completos de colecciones Postman incluyendo pruebas de API, scripts de automatización, variables de entorno, servidores mock y patrones avanzados de prueba para REST APIs
title token api
sample
Ejemplos OpenAI API
Ejemplos comprensivos de la API de OpenAI incluyendo modelos GPT, generación de imágenes DALL-E, procesamiento de audio Whisper y llamadas a funciones
title token api
sample
API Gráfica WebGPU
API gráfica moderna para gráficos 3D de alta performance y computación GPU en el navegador
title token api
sample
Ejemplos del Truffle Development Suite
Ejemplos del framework de desarrollo Ethereum Truffle incluyendo contratos inteligentes, pruebas, despliegue, migraciones, depuración y flujos de trabajo de desarrollo
keywords migration,contract,testing
sample

Preguntas frecuentes

¿Qué versiones de OpenAPI soporta la herramienta?

Actualmente soporta la comparación de esquemas basados en la especificación OpenAPI 3.x.

¿Qué se considera un 'breaking change' en una API?

Son cambios que rompen la compatibilidad con clientes existentes, como eliminar un endpoint, cambiar el tipo de un campo de texto a número, o hacer obligatorio un parámetro que antes era opcional.

¿La herramienta detecta cambios que no rompen la compatibilidad?

Se enfoca principalmente en identificar cambios incompatibles (breaking changes) y evaluar su impacto, para priorizar la estabilidad de las integraciones.

¿Mis esquemas OpenAPI se guardan en algún servidor?

No, el procesamiento se realiza de manera segura y los esquemas introducidos no se almacenan permanentemente.

¿En qué formato se entregan los resultados?

Los resultados se presentan en un reporte visual en formato HTML que agrupa los cambios por impacto y detalla los pasos de migración recomendados.

Documentación de la API

Punto final de la solicitud

POST /es/api/tools/api-breaking-changes-detector-migration-planner

Parámetros de la solicitud

Nombre del parámetro Tipo Requerido Descripción
oldSchema textarea No -
newSchema textarea No -

Formato de respuesta

{
  "result": "
Processed HTML content
",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
HTML: HTML

Documentación de MCP

Agregue este herramienta a su configuración de servidor MCP: 

{
  "mcpServers": {
    "elysiatools-api-breaking-changes-detector-migration-planner": {
      "name": "api-breaking-changes-detector-migration-planner",
      "description": "Compara dos esquemas OpenAPI 3.x, detecta cambios incompatibles y propone estrategias de migracion",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-breaking-changes-detector-migration-planner",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Puede encadenar múltiples herramientas, por ejemplo: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máximo 20 herramientas.

Si encuentra algún problema, por favor, póngase en contacto con nosotros en [email protected]