Lors de quelle modification de la réponse de l'API devons-nous augmenter la version, et lors de quelles modifications ne pas le faire?

La version de l’API doit être augmentée lors de modifications qui brisent la compatibilité descendante (changements disruptifs). Ces modifications incluent :

• La suppression ou le renommage de champs existants dans la réponse.
• La modification du type de données des champs.
• La modification de la structure de la réponse, empêchant les clients de traiter correctement les données.

Les changements qui ne nécessitent pas d’augmentation de version :

• L’ajout de nouveaux champs optionnels dans la réponse (les clients peuvent les ignorer).
• L’ajout de nouveaux endpoints.
• La correction d’erreurs qui n’affectent pas la structure et le format de la réponse.

Ainsi, si les changements peuvent casser les clients existants, il faut augmenter la version de l’API.