Il titolo dice tutto. Dovrei incrementare la mia versione API se aggiungo, diciamo, una proprietà immagine a ciascuna istanza della mia risorsa "Ristorante" rappresentata da JSON? o il controllo della versione dell'API dovrebbe cambiare solo quando l'implementazione cambia?
Supponiamo di aver rilasciato la versione 5.2.11.
Ora aggiungi immagini al tuo output JSON e continua a chiamarlo versione 5.2.11.
Ti piacerebbe che i tuoi clienti chiedessero quando saranno incluse le immagini, stai ancora eseguendo 5.2.11 non è cambiato nulla. Fidati di me, non controllano mai.
Non è molto più facile dirlo ai tuoi clienti: ora usiamo la versione 5.2.12, non devi cambiare nulla, ma se ti piace ci sono immagini aggiunte.
Il principio è piuttosto opposto. Incrementi la versione su qualsiasi piccola modifica dell'API a meno che non ci sia un motivo molto serio per non farlo.
Quali sono le tue ragioni? Come intendi documentare questa API? Come stai andando a scrivere quale versione dell'API è stata utilizzata per riprodurre un bug? Gli utenti API non saranno felici di sapere che "ora non garantiamo che i server con la stessa versione API restituiscano le stesse risposte".
Resta al sicuro e incrementa.
La versione dell'API deve cambiare se uno dei client ha problemi con le modifiche. Quindi scopri se i tuoi clienti hanno problemi con l'aggiunta di una proprietà dell'immagine.
Leggi altre domande sui tag api-design