La ce modificări ale răspunsului API trebuie să creștem versiunea și la care nu?

Versiunea API trebuie să fie crescută atunci când se fac modificări care încalcă compatibilitatea înapoi (schimbări disruptive). Aceste modificări includ:

• Eliminarea sau redenumirea câmpurilor existente în răspuns.
• Schimbarea tipului de date al câmpurilor.
• Schimbarea structurii răspunsului, ceea ce împiedică clienții să proceseze corect datele.

Modificările care nu necesită creșterea versiunii:

• Adăugarea de noi câmpuri opționale în răspuns (clienții le pot ignora).
• Adăugarea de noi endpoint-uri.
• Corectarea erorilor care nu afectează structura și formatul răspunsului.

Prin urmare, dacă modificările pot strica clienții existenți, trebuie să creșteți versiunea API.