Δημιουργία Εκδόσεων API και Απαξίωση

Το VaultPAM χρησιμοποιεί δημιουργία εκδόσεων κύριας διαδρομής για δημόσια HTTP APIs.

Μοντέλο δημιουργίας εκδόσεων

• Οι προσθετικές αλλαγές παραμένουν στην τρέχουσα κύρια έκδοση.
• Οι αναλλοίωτες αλλαγές απαιτούν μια νέα κύρια διαδρομή, όπως /api/v2/.
• Η τρέχουσα δημόσια κύρια έκδοση είναι v1.

Αναλλοίωτες αλλαγές

Μια αλλαγή είναι αναλλοίωτη όταν αφαιρεί ή περιορίζει ένα υπάρχον συμβόλαιο πελάτη, όπως:

• αφαίρεση ενός τελικού σημείου ή HTTP μεθόδου,
• να κάνει ένα προαιρετικό πεδίο αιτήματος υποχρεωτικό,
• αφαίρεση ενός πεδίου απόκρισης που χρησιμοποιούν υπάρχοντες πελάτες,
• αλλαγή ενός τύπου πεδίου με ασύμβατο τρόπο,
• περιορισμός κανόνων ελέγχου ταυτότητας ή πρόσβασης με τρόπο που διακόπτει τεκμηριωμένους πελάτες.

Απαξίωση και λήξη

• Οι απαξιωμένες λειτουργίες σημειώνονται στο συμβόλαιο API.
• Οι σημειώσεις έκδοσης περιλαμβάνουν οδηγίες μετανάστευσης στην ίδια έκδοση που εισάγει την απαξίωση.
• Η απαξιωμένη συμπεριφορά παραμένει διαθέσιμη για τουλάχιστον δύο ετικετοποιημένες παραγωγικές εκδόσεις πριν από την αφαίρεση.
• Οι ημερομηνίες λήξης ανακοινώνονται εκ των προτέρων ώστε οι πελάτες να μπορούν να σχεδιάσουν τη μετανάστευσή τους.

Υποστήριξη μετανάστευσης

Όταν το API αλλάζει, η διαδρομή αντικατάστασης πρέπει να τεκμηριωθεί παράλληλα με την ειδοποίηση απαξίωσης. Οι πελάτες δεν θα πρέπει να χρειάζεται να μαντέψουν ποιο τελικό σημείο ή σχήμα φορτίου πρέπει να χρησιμοποιήσουν στη συνέχεια.

Χρειάζεστε βοήθεια;

Χρησιμοποιήστε την αναφορά ζωντανού API για λεπτομέρειες τρέχοντος τελικού σημείου και τις σημειώσεις έκδοσης για αλλαγές που επηρεάζουν αναβαθμίσεις.