Objetivo y alcance
Compara versiones de API, planifica la migracion y acepta la compatibilidad antes del lanzamiento. Las herramientas no sustituyen el despliegue real ni la monitorizacion.
Esta guía convierte el alcance indicado en un resultado revisable. Conserve la fuente, los resultados intermedios y las decisiones para que la siguiente persona entienda qué se comprobó y por qué.
Preparar evidencia y tomar decisiones
Prepara las especificaciones versionadas antigua y nueva y casos representativos.
Define reglas de compatibilidad, consumidores afectados, umbrales y un entorno de prueba autorizado.
Decisión: Que herramienta de comparacion corresponde?. Elige api-breaking-changes-detector-migration-planner para dos schemas OpenAPI 3.x y estrategias de migracion. Elige openapi-diff-breach-detector para un diff orientado al impacto de OpenAPI o GraphQL.
Completar el flujo de trabajo
1. Compara las versiones
Valida y compara las especificaciones y clasifica elementos del contrato eliminados o restringidos. Usar openapi-validator, api-breaking-changes-detector-migration-planner, openapi-diff-breach-detector.
2. Comprueba la compatibilidad
Valida respuestas capturadas, compara payloads y genera casos limite o de mutacion; usa peticiones solo en un backend autorizado. Usar api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester.
3. Acepta el plan de migracion
Registra acciones de consumidores, evidencia de SemVer y changelog, bloqueos o exenciones y responsables separados del release y la monitorizacion. Usar semver-validator, changelog-extractor, package-json-dependency-auditor.
Verificar el resultado antes de la entrega
- Cada hallazgo incompatible tiene ubicacion, impacto en clientes, accion de migracion o compatibilidad y responsable.
- Las comprobaciones de respuestas, limites y mutaciones pasan o tienen bloqueo o exencion explicitos; el release real y la monitorizacion tienen responsables separados.
Preguntas frecuentes
- Estas herramientas despliegan o monitorizan produccion? No. Analizan especificaciones, payloads guardados, casos generados y peticiones de prueba autorizadas. El release real y la monitorizacion se hacen aparte.
- Que es un cambio incompatible? Eliminar una operacion, campo o estado de respuesta, restringir una entrada, cambiar un tipo o hacer obligatoria una entrada opcional puede romper consumidores.
- Que debe incluir el plan de migracion? Cada hallazgo necesita consumidor afectado, accion, responsable, fecha limite, evidencia de prueba e hipotesis de rollback.