Bij welke wijzigingen in de API-respons moeten we de versie verhogen en bij welke niet?

De API-versie moet worden verhoogd bij het aanbrengen van wijzigingen die de achterwaartse compatibiliteit (breaking changes) verstoren. Deze wijzigingen omvatten:

• Het verwijderen of hernoemen van bestaande velden in de reactie.
• Het wijzigen van het gegevenstype van velden.
• Het wijzigen van de structuur van de reactie, waardoor clients de gegevens niet correct kunnen verwerken.

Wijzigingen die geen verhoging van de versie vereisen:

• Het toevoegen van nieuwe optionele velden aan de reactie (clients kunnen deze negeren).
• Het toevoegen van nieuwe eindpunten.
• Het corrigeren van fouten die de structuur en het formaat van de reactie niet beïnvloeden.

Dus, als wijzigingen bestaande clients kunnen breken, moet de API-versie worden verhoogd.