Glossar   /   API-Entwicklung

Breaking Change

Ein Breaking Change ist eine Änderung, durch die bisher passend angebundene Anwendungen nicht mehr unverändert funktionieren.

Auch bekannt als: Inkompatible Änderung

Was bedeutet Breaking Change?

Ein entferntes Datenfeld, eine neue Pflichtangabe oder eine andere Bedeutung kann bestehende Verbindungen beschädigen. Entscheidend ist die Wirkung auf die nutzenden Anwendungen, nicht die Größe der Änderung im Programmcode.

Auch zusätzliche Felder können problematisch sein, wenn Empfänger unbekannte Angaben ablehnen. Änderungen sollten daher anhand vereinbarter Regeln und realistischer Nutzerfälle geprüft und rechtzeitig angekündigt werden.

So sieht das in der Praxis aus

Beispiel: Eine Auftragskennung wird ohne Übergangsregel von einer Zahl zu einem Text. Eine ältere Anwendung kann die Antwort danach nicht mehr lesen.

Häufige Fragen

Kann auch eine kleine Änderung eine Verbindung beschädigen?

Ja. Schon ein geänderter Datentyp oder eine neue Pflichtangabe kann vorhandene Anfragen ungültig machen. Maßgeblich sind die bisherigen Erwartungen der angebundenen Anwendungen.

Sind neue Felder immer rückwärtskompatibel?

Nein. Manche Anwendungen prüfen Antworten sehr streng. Ein zusätzliches Feld oder ein neuer Auswahlwert kann dann eine Anpassung nötig machen.

Wie lässt sich eine unverträgliche Änderung einführen?

Mit klarer Ankündigung, dokumentierten Anpassungen und einer passenden Übergangsphase. Je nach Vereinbarung bleibt die bisherige Version während der Umstellung verfügbar.

Das könnte Sie auch interessieren

Passend zum Thema

API-Entwicklung Agentur Änderungen an bestehenden Verbindungen und ihre Auswirkungen berücksichtigen.

Quellen und weiterführende Informationen

Google AIP-180: Backwards Compatibility
← Zurück zu allen Glossarbegriffen

Änderungen an Verbindungen vorbereiten

Eine bestehende Anbindung soll sich ändern? Prüfen Sie die betroffenen Nutzer, nötige Anpassungen und einen geeigneten Übergang.

Kontakt aufnehmen