In quali modifiche della risposta API dobbiamo aumentare la versione e in quali no?

La versione dell’API dovrebbe essere aumentata quando vengono apportate modifiche che rompono la compatibilità retroattiva (cambiamenti che interrompono). Questi cambiamenti includono:

• Rimuovere o rinominare campi esistenti nella risposta.
• Modificare il tipo di dati dei campi.
• Modificare la struttura della risposta, impedendo ai clienti di elaborare correttamente i dati.

I cambiamenti che non richiedono l’aumento della versione:

• Aggiunta di nuovi campi opzionali nella risposta (i clienti possono ignorarli).
• Aggiunta di nuovi endpoint.
• Correzione di errori che non influenzano la struttura e il formato della risposta.

Pertanto, se i cambiamenti possono rompere i clienti esistenti, è necessario aumentare la versione dell’API.