Bei welchen Änderungen der API-Antwort sollten wir die Version erhöhen und bei welchen nicht?

Die Version der API sollte erhöht werden, wenn Änderungen vorgenommen werden, die die Rückwärtskompatibilität (breaking changes) beeinträchtigen. Solche Änderungen umfassen:

• Das Entfernen oder Umbenennen bestehender Felder in der Antwort.
• Das Ändern des Datentyps der Felder.
• Das Ändern der Antwortstruktur, wodurch Clients die Daten nicht korrekt verarbeiten können.

Änderungen, die keine Versionserhöhung erfordern:

• Das Hinzufügen neuer optionaler Felder in der Antwort (Clients können diese ignorieren).
• Das Hinzufügen neuer Endpunkte.
• Das Beheben von Fehlern, die die Struktur und das Format der Antwort nicht beeinflussen.

Wenn Änderungen die bestehenden Clients beschädigen könnten, muss die API-Version erhöht werden.