Έκδοση σύμβασης

Έκδοση σύμβασης

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

Αυτό είναι κρίσιμο στην αρχιτεκτονική μικροϋπηρεσιών, τις ενοποιήσεις B2B και τα ανοικτά προϊόντα API όπου διαφορετικοί πελάτες χρησιμοποιούν διαφορετικές εκδόσεις των διεπαφών.

Τι εκδίδουμε

Object\Περιγραφή

	------------------------------	-------------------------------------------------------------------------
Προδιαγραφές OpenAPI
Καταληκτικά σημεία Προσθήκη εκδόσεων στο URL ('/v1/', '/v2/'), αποθήκευση συμβατότητας προς τα πίσω
Σύμφωνο, Dredd Fix Client-Server Terms
Data Models Change Control in Request and Response Structure

Πώς θα εφαρμόσουμε

Παράλληλη υποστήριξη πολλαπλών εκδόσεων API
Ρητή έκδοση σε URL, κεφαλίδες ή παραμέτρους
Αυτόματη συλλογή κάθε έκδοσης σύμβασης (Σύμφωνο, Ταχυδρόμος, Jest, Dredd)
Προδιαγραφές έκδοσης σε Git ή μέσω CI/CD
Τεκμηρίωση και changelog για τους πελάτες για κάθε αλλαγή

Πλεονεκτήματα

Εγγυημένη σταθερότητα της ολοκλήρωσης
Ικανότητα απελευθέρωσης νέων χαρακτηριστικών χωρίς τον κίνδυνο «διακοπής» πελατών
Απλούστευση της μετάβασης μεταξύ των εκδόσεων
Ιστορικό σαφών αλλαγών και έλεγχος των συμβάσεων
Διαφάνεια για τις εξωτερικές και εσωτερικές ομάδες ανάπτυξης

Όπου είναι ιδιαίτερα σημαντικό

Αρχιτεκτονική μικροϋπηρεσίας πολλαπλών εξαρτήσεων
Δημόσιες ή Β2Β πλατφόρμες API
Χρηματοοικονομικά συστήματα και συστήματα πληρωμών με μακροπρόθεσμες συμβάσεις
Εφαρμογές κινητής τηλεφωνίας που εξαρτώνται από μια σταθερή API

Η έκδοση των συμβάσεων αποτελεί τη βάση της προβλεψιμότητας και της εμπιστοσύνης στα API. Εφαρμόζουμε διαδικασίες που σας επιτρέπουν να αλλάξετε και να αναπτύξετε API χωρίς πόνο, διατηρώντας παράλληλα τη συμβατότητα και τη διαφάνεια για όλα τα μέρη.