Objectif et périmètre
Comparez les versions d API, planifiez la migration et acceptez la compatibilite avant la release. Les outils ne remplacent ni le deploiement reel ni la supervision.
Ce guide transforme le périmètre annoncé en résultat vérifiable. Conservez la source, les résultats intermédiaires et les décisions afin que la personne suivante comprenne ce qui a été contrôlé et pourquoi.
Préparer les éléments et décider
Preparez les specifications versionnees ancienne et nouvelle et des cas representatifs.
Definissez les regles de compatibilite, les consommateurs affectes, les seuils et un environnement de test autorise.
Décision: Quel outil de comparaison choisir ?. Choisissez api-breaking-changes-detector-migration-planner pour deux schemas OpenAPI 3.x et des strategies de migration. Choisissez openapi-diff-breach-detector pour un diff oriente impact de schemas OpenAPI ou GraphQL.
Réaliser le workflow
1. Comparer les versions
Validez et comparez les specifications, puis classez les elements de contrat supprimes ou durcis. Utiliser openapi-validator, api-breaking-changes-detector-migration-planner, openapi-diff-breach-detector.
2. Verifier la compatibilite
Validez des reponses capturees, comparez les payloads et generez des cas limites ou de mutation ; utilisez les requetes seulement sur un backend autorise. Utiliser api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester.
3. Accepter le plan de migration
Consignez les actions clients, les preuves SemVer et changelog, les blocages ou derogations et les responsables distincts de la release et de la supervision. Utiliser semver-validator, changelog-extractor, package-json-dependency-auditor.
Vérifier le résultat avant la remise
- Chaque constat cassant indique son emplacement, son impact client, son action de migration ou de compatibilite et son responsable.
- Les controles de reponses, de limites et de mutations reussissent ou ont un blocage ou une derogation explicite ; release et supervision ont des responsables distincts.
Questions fréquentes
- Ces outils deployent-ils ou surveillent-ils la production ? Non. Ils analysent specifications, payloads sauvegardes, cas generes et requetes de test autorisees. La release reelle et la supervision sont separees.
- Qu est-ce qu un changement cassant ? Supprimer une operation, un champ ou un statut, durcir une entree, changer un type ou rendre obligatoire une entree optionnelle peut casser des consommateurs.
- Que doit contenir le plan de migration ? Chaque constat doit indiquer le consommateur affecte, l action, le responsable, l echeance, la preuve de test et l hypothese de retour arriere.