Αποσαφηνίστε το έργο και την απόφαση
Αυτός ο οδηγός μετατρέπει τη γρήγορη εκκίνηση του api σε μια ροή εργασίας με δυνατότητα αναθεώρησης. Συνδέει αποφάσεις τομέα, ιδιοκτησία, αποδεικτικά στοιχεία και αποδοχή, ώστε το αποτέλεσμα να συνεχίσει να λειτουργεί στην παραγωγή.
Ξεκινήστε με ένα πιστοποιημένο αίτημα, επικυρώστε το συμβόλαιο απόκρισης και προσθέστε χειρισμό αποτυχίας πριν συνδέσετε το CMS.
Πρακτική διαδικασία
- 1
Τύποι πηγής αποθέματος, αναγνωριστικά, πεδία, τοπικές ρυθμίσεις, ιδιοκτήτες και καταστάσεις δημοσίευσης.
- 2
Επιλέξτε το μοτίβο προβολής από τον όγκο, τον λανθάνοντα χρόνο, τον έλεγχο σύνταξης και την ανοχή αποτυχίας.
- 3
Αντιστοιχίστε την εγγραφή προέλευσης σε μια ξεχωριστή εγγραφή γλώσσας-έκδοσης με ανθεκτική σύνδεση.
- 4
Προσθέστε έλεγχο ταυτότητας, ανικανότητα, επανάληψη, ακύρωση προσωρινής μνήμης, καταγραφή και στοιχεία ελέγχου πρόσβασης.
- 5
Δοκιμαστική δημοσίευση, αλλαγές πηγής, μη διαθέσιμα αποτελέσματα, επαναφορά, λειτουργία πληκτρολογίου και παρακολούθηση πριν από την κυκλοφορία.
Παράδειγμα ή εργαλείο
Ένα πλήρες ζεύγος αιτήματος και απάντησης περιλαμβάνει έλεγχο ταυτότητας, τοπικές ρυθμίσεις, τρόπο λειτουργίας, αδυναμία και χειρισμό σφαλμάτων. Στο εργαλείο, καταγράψτε επίσης τη γραμμή βάσης, τον ιδιοκτήτη, την απόφαση, τα αποδεικτικά στοιχεία, την ανοιχτή έκδοση και την ημερομηνία έγκρισης. Χρησιμοποιήστε μια πραγματική σελίδα ή μια συναλλαγή, ώστε η ομάδα να βλέπει τις εξαρτήσεις, τις εξαιρέσεις και τις εργασίες συντήρησης που ακολουθούν την κυκλοφορία.
| Σημείο απόφασης | Ρεκόρ | Κριτήριο αποδοχής |
|---|---|---|
| Βασική γραμμή | Παρατηρήθηκε η τρέχουσα κατάσταση | Πηγή και ημερομηνία καταγραφής |
| Απόφαση | Επιλεγμένη επιλογή και λογική | Το ρίσκο και το κοινό εξετάζονται |
| Απόδειξη | Δοκιμή, τεκμηρίωση ή μέτρηση | Δυνατότητα αναθεώρησης και συγκεκριμένη έκδοση |
| Εγκριση | Όνομα, ρόλος και ημερομηνία | Όλα τα υποχρεωτικά κριτήρια πληρούνται |
Στείλτε ένα αίτημα σε σχήμα παραγωγής
Δημιουργήστε έναν πελάτη ενοποίησης από την πλευρά του διακομιστή και αποθηκεύστε τα διαπιστευτήριά του στη διαχείριση μυστικών ανάπτυξης. Στείλτε UTF-8 JSON μέσω HTTPS με σταθερό αναγνωριστικό πηγής, αναθεώρηση πηγής, τοπικές ρυθμίσεις που ζητήθηκαν, λειτουργία γλώσσας και σώμα περιεχομένου. Προσθέστε ένα κλειδί ανικανότητας που παραμένει το ίδιο όταν ξαναδοκιμάζεται η ίδια εργασία. Μην εκθέτετε διαπιστευτήρια σε κώδικα προγράμματος περιήγησης, αρχεία αποθήκης, πεδία CMS, στιγμιότυπα οθόνης ή απαντήσεις σφαλμάτων ορατές από τον πελάτη.
Ξεκινήστε με μια αντιπροσωπευτική αλλά μη ευαίσθητη σελίδα υπηρεσίας. Συμπεριλάβετε επικεφαλίδες, λίστες, συνδέσμους και μια νομική ή λειτουργική προϋπόθεση, ώστε η απάντηση να ασκεί το πραγματικό συμβόλαιο περιεχομένου. Απορρίψτε ένα κενό αναγνωριστικό πηγής, μη υποστηριζόμενες τοπικές ρυθμίσεις, άγνωστη λειτουργία, σώμα μεγάλου μεγέθους ή κακής μορφής δομή πριν καλέσετε το API. Ορίστε ένα ρητό χρονικό όριο σύνδεσης και απόκρισης και διαδώστε ένα αναγνωριστικό συσχέτισης στα αρχεία καταγραφής της εφαρμογής σας.
| Πεδίο αιτήματος | Σκοπός | Νομιμοποίηση |
|---|---|---|
| sourceId | Ανθεκτική σύνδεση με το δίσκο CMS | Απαιτούμενο, σταθερό, μη προσωπικό |
| πηγήΑναθεώρηση | Ανιχνεύει μπαγιάτικα αποτελέσματα | Απαιτούμενο και αμετάβλητο για το αίτημα |
| τοπική ρύθμιση και λειτουργία | Επιλέγει κανόνες γλώσσας | Πρέπει να είναι ενεργοποιημένος συνδυασμός |
| idempotencyKey | Κάνει τις επαναλήψεις ασφαλείς | Η ίδια λειτουργία χρησιμοποιεί το ίδιο κλειδί |
Επικυρώστε το πλήρες συμβόλαιο απάντησης
Αντιμετωπίστε μια επιτυχημένη κατάσταση HTTP ως μόνο τον πρώτο έλεγχο. Επικυρώστε το σχήμα απόκρισης, το αναγνωριστικό αποτελέσματος, το αναγνωριστικό πηγής και την αναθεώρηση, τις τοπικές ρυθμίσεις, τη λειτουργία γλώσσας, την κατάσταση επεξεργασίας, τα μπλοκ περιεχομένου, τις προειδοποιήσεις και την έκδοση μοντέλου ή συνόλου κανόνων όπου παρέχονται. Οι άγνωστες τιμές enum και τα απαιτούμενα πεδία που λείπουν θα πρέπει να αποτύχουν να κλείσουν σε σφάλμα ενσωμάτωσης με δυνατότητα αναθεώρησης. Διατηρήστε τις προειδοποιήσεις δίπλα στο πρόχειρο, επειδή μπορούν να προσδιορίσουν την ορολογία, την ποιότητα της πηγής ή τις απαιτήσεις για μη αυτόματο έλεγχο.
Αποθηκεύστε τα παραγόμενα αποτελέσματα ως ξεχωριστή πρόχειρη αναθεώρηση αντί να αντικαταστήσετε την εγκεκριμένη πηγή. Καταγράψτε αναγνωριστικά αιτημάτων και αποτελεσμάτων, ρυθμίσεις μετασχηματισμού, χρονικές σημάνσεις και έναν κατακερματισμό ακεραιότητας της αναθεώρησης πηγής. Αποδώστε μια διαφορά για τους αναθεωρητές και αποφύγετε όλα τα αποτελέσματα σύμφωνα με τον προορισμό τους. Η δημιουργημένη σήμανση είναι μη αξιόπιστη είσοδος μέχρι να ολοκληρωθεί η επικύρωση σχήματος, η απολύμανση, οι έλεγχοι προσβασιμότητας και η ανθρώπινη έγκριση.
- 1
Επικυρώστε το εξερχόμενο ωφέλιμο φορτίο σε σχέση με ένα τοπικό σχήμα.
- 2
Στείλτε το αίτημα με κεφαλίδες ελέγχου ταυτότητας, χρονικού ορίου, αδυναμίας και συσχέτισης.
- 3
Επικυρώστε την κατάσταση, τις κεφαλίδες και το σώμα απόκρισης σε σχέση με το καρφιτσωμένο συμβόλαιο.
- 4
Δημιουργήστε ένα ξεχωριστό προσχέδιο CMS που συνδέεται με την ακριβή αναθεώρηση της πηγής.
- 5
Προειδοποιήσεις διαδρομής και διαφέρει στη σωστή ουρά κριτικής σύνταξης.
Χειριστείτε τα σφάλματα χωρίς να αντιγράψετε ή να χάσετε εργασία
Δοκιμάστε ξανά χρονικά όρια, αποτυχίες σύνδεσης και όρια ρυθμών μόνο όταν η λειτουργία είναι ανίκανη. Χρησιμοποιήστε περιορισμένο εκθετικό backoff με jitter και σεβαστείτε μια καθυστέρηση επανάληψης που παρέχεται από τον διακομιστή. Μην επιχειρήσετε ξανά αποτυχίες επικύρωσης, αποτυχίες ελέγχου ταυτότητας ή μη υποστηριζόμενες επιλογές έως ότου αλλάξει η διαμόρφωση. Τοποθετήστε τις εξαντλημένες λειτουργίες σε μια ουρά νεκρών γραμμάτων με την αναφορά πηγής, την ασφαλή κατηγορία σφαλμάτων, τον αριθμό προσπαθειών και την επόμενη υπεύθυνη ομάδα.
Διαχωρίστε την κατάσταση του χρήστη από τη διαγνωστική λεπτομέρεια. Οι συντάκτες χρειάζονται ξεκάθαρες καταστάσεις όπως σε ουρά, επεξεργασία, έτοιμο σχέδιο, απαιτούμενη ενέργεια και αποτυχία με ένα ασφαλές επόμενο βήμα. Οι λειτουργίες χρειάζονται αναγνωριστικά αιτημάτων, διάρκεια, κατηγορία κατάστασης και ιστορικό επανάληψης, αλλά όχι το πλήρες κείμενο προέλευσης στα συνηθισμένα αρχεία καταγραφής. Ειδοποίηση για σταθερό ποσοστό σφάλματος, αυξανόμενη ηλικία ουράς, αποτυχίες ελέγχου ταυτότητας, αναντιστοιχίες σχημάτων και πρόχειρα των οποίων η αναθεώρηση πηγής άλλαξε κατά την επεξεργασία.
Κάθε λειτουργία με δυνατότητα επανάληψης έχει ένα σταθερό κλειδί αδυναμίας.
Το backoff περιορίζεται και τιμά τις οδηγίες ορίου ποσοστού.
Τα αρχεία καταγραφής εξαιρούν τα διαπιστευτήρια και τα περιττά σώματα περιεχομένου.
Τα στοιχεία με νεκρά γράμματα έχουν κάτοχο και διαδικασία επανάληψης.
Ένα παλιό αποτέλεσμα δεν μπορεί να αντικαταστήσει σιωπηλά μια νεότερη αναθεώρηση πηγής.
Αποδείξτε την ενσωμάτωση πριν από την κυκλοφορία
Δοκιμάστε έγκυρα αιτήματα, κάθε τεκμηριωμένο σφάλμα επικύρωσης, ληγμένα και ανακληθέντα διαπιστευτήρια, χρονικά όρια, όρια τιμών, διπλότυπη υποβολή, ολοκλήρωση εκτός σειράς, εξέλιξη σχήματος, απολύμανση και αλλαγές πηγής κατά την επεξεργασία. Επιβεβαιώστε ότι η παρακολούθηση προσδιορίζει κάθε αποτυχία και ότι ένας εκπαιδευμένος χειριστής μπορεί να αναπαράγει ξανά ή να κλείσει το στοιχείο χωρίς επεξεργασία βάσης δεδομένων. Εκτελέστε προσβασιμότητα και συντακτική αναθεώρηση στο προσχέδιο που έχει αποδοθεί και όχι μόνο στην ακατέργαστη απάντηση.
Κυκλοφορεί με περιορισμένα διαπιστευτήρια, καθορισμένα όρια τιμών και δαπανών, πίνακες ελέγχου, ιδιοκτησία ειδοποιήσεων και διακόπτη επαναφοράς που σταματά τη νέα γενιά χωρίς να επηρεάζει το δημοσιευμένο περιεχόμενο. Καρφιτσώστε την υποστηριζόμενη έκδοση του συμβολαίου και προγραμματίστε έναν έλεγχο αναβάθμισης. Το αρχείο αποδοχής παραγωγής θα πρέπει να περιλαμβάνει τεκμήρια δοκιμών, έγκριση ασφαλείας, τεκμηρίωση ροής δεδομένων, υπογραφή ελεγκτή, οδηγίες λειτουργίας και την επιτυχή αποκατάσταση μιας σκόπιμα αποτυχημένης εργασίας.
Ρόλοι, στοιχεία και έγκριση
Κρατήστε τη γενιά ξεχωριστή από τη δημοσίευση. Μια επιτυχημένη απάντηση είναι ένα προσχέδιο, όχι μια έγκριση. Αποθηκεύστε το αναγνωριστικό πηγής και την έκδοση, τις ρυθμίσεις μετασχηματισμού, το αναγνωριστικό αποτελέσματος, την κατάσταση αναθεώρησης, τον υπεύθυνο έγκρισης και τον χρόνο δημοσίευσης. Όταν αλλάξει η πηγή, επισημάνετε την έκδοση γλώσσας για έλεγχο αντί να αντικαθιστάτε σιωπηλά το εγκεκριμένο περιεχόμενο. Αυτό καθιστά δυνατή την επαναφορά και τον έλεγχο σε όλες τις πλατφόρμες.
Λειτουργίες και συντήρηση
Το έργο δεν τελειώνει στη δημοσίευση. Συνδέστε την έκδοση ή τη διαμόρφωση γλώσσας με την πηγή της, παρακολουθήστε τα μέτρα ποιότητας και εξυπηρέτησης και ορίστε συγκεκριμένα στοιχεία ενεργοποίησης ελέγχου. Οι κανόνες ενεργοποίησης περιλαμβάνουν αλλαγές πηγής, νομικές αλλαγές, νέες ανάγκες κοινού, επαναλαμβανόμενες ερωτήσεις υποστήριξης, τεχνικές αλλαγές και συμβάντα. Ένας επώνυμος κάτοχος αξιολογεί τον κανόνα ετικέτας, ανοίγει μια νέα αναθεώρηση όταν χρειάζεται και καταγράφει την ανανεωμένη έγκριση.
Κατάλογος ελέγχου δημοσίευσης
Η ενοποίηση χρησιμοποιεί ανθεκτικά αναγνωριστικά πηγής.
Τα διαπιστευτήρια αποθηκεύονται στην πλευρά του διακομιστή και εναλλάσσονται.
Καθορίζονται το χρονικό όριο, η επανάληψη και η συμπεριφορά ορίου ρυθμού.
Τα επαναλαμβανόμενα αιτήματα είναι ανίκανα.
Το περιεχόμενο που δημιουργείται εισέρχεται σε κατάσταση ελέγχου.
Οι αλλαγές στην πηγή ακυρώνουν ή ανοίγουν ξανά την έκδοση.
Η πλοήγηση γλώσσας λειτουργεί με πληκτρολόγιο και υποστηρικτική τεχνολογία.
Η παρακολούθηση καλύπτει αποτυχίες, ουρές, λανθάνουσα κατάσταση και μπαγιάτικο περιεχόμενο.