Σε ποιες αλλαγές της απάντησης API πρέπει να αυξάνουμε την έκδοση και σε ποιες όχι;

Η έκδοση του API θα πρέπει να αυξάνεται όταν γίνονται αλλαγές που διακόπτουν την backwards compatibility (breaking changes). Τέτοιες αλλαγές περιλαμβάνουν:

• Διαγραφή ή μετονομασία υπαρχόντων πεδίων στην απάντηση.
• Αλλαγή του τύπου δεδομένων των πεδίων.
• Αλλαγή της δομής της απάντησης, που εμποδίζει τους πελάτες να επεξεργαστούν σωστά τα δεδομένα.

Οι αλλαγές που δεν απαιτούν αύξηση της έκδοσης:

• Προσθήκη νέων προαιρετικών πεδίων στην απάντηση (οι πελάτες μπορούν να τα αγνοήσουν).
• Προσθήκη νέων endpoints.
• Διόρθωση σφαλμάτων που δεν επηρεάζουν τη δομή και τη μορφή της απάντησης.

Επομένως, αν οι αλλαγές μπορούν να σπάσουν τους υπάρχοντες πελάτες, πρέπει να αυξήσετε την έκδοση του API.