Ziel und Umfang
Vergleichen Sie API-Versionen, planen Sie Migrationen und nehmen Sie die Kompatibilitaet vor dem Release ab. Die Tools ersetzen weder echtes Deployment noch Monitoring.
Dieser Leitfaden macht aus dem beschriebenen Umfang ein überprüfbares Ergebnis. Bewahren Sie Quelle, Zwischenergebnisse und Entscheidungen auf, damit andere nachvollziehen können, was geprüft wurde und warum.
Nachweise vorbereiten und Entscheidungen treffen
Halten Sie versionierte alte und neue Spezifikationen sowie repraesentative Faelle bereit.
Legen Sie Kompatibilitaetsregeln, betroffene Konsumenten, Schwellen und eine autorisierte Testumgebung fest.
Entscheidung: Welches Vergleichstool passt?. Waehlen Sie api-breaking-changes-detector-migration-planner fuer zwei OpenAPI-3.x-Schemas und Migrationsstrategien. Waehlen Sie openapi-diff-breach-detector fuer einen wirkungsorientierten Diff von OpenAPI- oder GraphQL-Schemas.
Workflow durchführen
1. Versionen vergleichen
Validieren und vergleichen Sie die Spezifikationen und klassifizieren Sie entfernte oder verschaerfte Vertragselemente. Verwenden openapi-validator, api-breaking-changes-detector-migration-planner, openapi-diff-breach-detector.
2. Kompatibilitaet pruefen
Pruefen Sie aufgezeichnete Antworten, vergleichen Sie Payloads und erzeugen Sie Grenz- oder Mutationsfaelle; Anfragen gehen nur an ein autorisiertes Backend. Verwenden api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester.
3. Migrationsplan abnehmen
Dokumentieren Sie Client-Aktionen, SemVer- und Changelog-Nachweise, Sperren oder Ausnahmen sowie getrennte Verantwortliche fuer Release und Monitoring. Verwenden semver-validator, changelog-extractor, package-json-dependency-auditor.
Ergebnis vor der Übergabe prüfen
- Jeder Breaking-Change-Befund nennt Ort, Client-Auswirkung, Kompatibilitaets- oder Migrationsaktion und Verantwortlichen.
- Antwort-, Grenz- und Mutationspruefungen bestehen oder haben eine ausdrueckliche Sperre oder Ausnahme; Release und Monitoring haben getrennte Verantwortliche.
Häufige Fragen
- Deployen oder ueberwachen diese Tools die Produktion? Nein. Sie analysieren Spezifikationen, gespeicherte Payloads, erzeugte Faelle und autorisierte Testanfragen. Echtes Release und Monitoring erfolgen separat.
- Was ist ein Breaking Change? Das Entfernen eines Vorgangs, Felds oder Status, das Verschaerfen einer Eingabe, ein geaenderter Typ oder ein neues Pflichtfeld kann Konsumenten brechen.
- Was muss der Migrationsplan enthalten? Jeder Befund braucht betroffene Konsumenten, Aktion, Verantwortlichen, Termin, Testnachweis und Rollback-Annahme.