Zum Inhalt springen

Breaking Change

Eine Änderung, durch die bisher unterstützte Verbraucher oder Nutzungen nicht mehr wie vereinbart funktionieren.

Softwarearchitektur

Eine bestehende Zusage wird unverträglich geändert

Ein Breaking Change verändert einen unterstützten Vertrag so, dass bisherige Verbraucher angepasst werden müssen oder ihr vereinbartes Verhalten verlieren. Das kann Datenformat, Pflichtangaben oder die Bedeutung eines Ergebnisses betreffen.

Im erfundenen Beispiel entfernt eine Auftrags-API das bisher zugesagte Feld orderId. Ein Bericht, der darauf angewiesen ist, kann den Auftrag nicht mehr zuordnen. Eine interne Umbenennung ohne Auswirkung auf den öffentlichen Vertrag wäre dagegen kein solcher Bruch. Prüfen Sie betroffene Verbraucher, Übergangsweg und Kommunikation vor der Freigabe. Eine neue Versionsnummer allein passt keinen Verbraucher an. Auch ein unverändertes Antwortformat kann eine unverträgliche fachliche Verhaltensänderung enthalten.

Quellen