Κατά τη συνεργασία με API μεταξύ ομάδων ή εξωτερικών εταίρων, είναι ιδιαίτερα σημαντικό η μορφή των αιτήσεων και των απαντήσεων να παραμένει προβλέψιμη. Ο έλεγχος της σύμβασης σας επιτρέπει να επαληθεύσετε ότι και τα δύο μέρη - ο πελάτης και ο διακομιστής - συμφωνούν με τη δομή ανταλλαγής και δεν την παραβιάζουν κατά τις επικαιροποιήσεις.
Εφαρμόζουμε δοκιμές συμβάσεων που ελέγχουν αυτόματα τη συμμόρφωση της API με την τεκμηρίωση ή τις προσδοκίες των καταναλωτών - πριν ξεκινήσουμε την παραγωγή.
Τι είναι μια σύμβαση API
Σύμβαση είναι συμφωνία που ορίζει:- ποια πεδία περιέχουν το αίτημα και την απάντηση
- Ποιοι μορφότυποι δεδομένων επιτρέπονται
- ποιοι κωδικοί κατάστασης επιστρέφονται
- ποιες υποχρεωτικές παράμετροι απαιτούνται
Παραβίαση σύμβασης = πιθανή αποτυχία πελάτη ή υπηρεσίας.
Πώς λειτουργεί
| Συμβαλλόμενο μέρος | Τι ελέγχεται |
|---|---|
| Πάροχος (API) | Η API πρέπει να ανταποκρίνεται στις προσδοκίες των πελατών για τη δομή απόκρισης |
| Πελάτης (καταναλωτής) | Ο πελάτης αναμένει ένα συγκεκριμένο σύστημα - οι έλεγχοι ότι πληρούται |
| Αμφίδρομη διεύθυνση | Αμφίδρομη δοκιμή: τόσο ο πελάτης όσο και ο εξυπηρετητής συμφωνούν με τη σύμβαση |
Χρησιμοποιούμενα εργαλεία: Σύμφωνο, εαρινό συμβόλαιο υπολογιστικού νέφους, Dredd, Postman Contract Tests.
Οφέλη του ελέγχου των συμβάσεων
Ταυτοποίηση των περιπτώσεων μη συμμόρφωσης πριν από την εξάντληση- Προστασία από «σιωπηλές» αλλαγές που διακόπτουν τους πελάτες
- Ασφαλής ενημέρωση των εκδόσεων API
- Αύξηση της εμπιστοσύνης μεταξύ των αναπτυξιακών ομάδων
- Ιστορικό αλλαγής σύμβασης καταγραφής
Πώς θα εφαρμόσουμε
Ορισμός συμβάσεων OpenAPI/Συμφώνου- Ενσωμάτωση CI με αυτόματες δοκιμές σε κάθε δέσμευση
- Οπτικοποίηση και ιστορικό μεταβολών των συμβάσεων
- Στάθμευση/παραγωγή
- Συμβάσεις δημοσίευσης για εξωτερικούς φορείς ολοκλήρωσης
Όπου είναι ιδιαίτερα σημαντικό
Μικροϋπηρεσίες επιμερισμένης ευθύνης- Πλατφόρμες με εξωτερικές ενοποιήσεις Β2Β
- Εργασία σε API με πολλαπλές ανεξάρτητες εντολές
- Κρίσιμα συστήματα όπου το σφάλμα είναι απαράδεκτο (χρηματοδότηση, δημόσιες υπηρεσίες)
Η δοκιμή σύμβασης είναι μια αξιόπιστη γέφυρα μεταξύ του εξυπηρετητή και του πελάτη. Θα σας βοηθήσουμε να οικοδομήσετε μια διαδικασία κατά την οποία καμία επικαιροποίηση δεν διαταράσσει την ολοκλήρωση και δεν δημιουργεί απροσδόκητα σφάλματα.
Δημοφιλή θέματα
Βασικά θέματα
Επικοινωνήστε μαζί μας
Συμπληρώστε την παρακάτω φόρμα και θα σας απαντήσουμε το συντομότερο δυνατό.