Εντοπισμός προβλημάτων σε ένα εισαγόμενο API

Όταν εισάγετε ένα API (OpenAPI, Swagger και τις άλλες υποστηριζόμενες μορφές), το Restorm διατηρεί την δομημένη τεκμηρίωση του API στον φάκελο μεταβλητών του. Αμέσως μετά την εισαγωγή — και κάθε φορά που ανοίγετε ξανά το αρχείο — το Restorm προβάλλει διακριτικά αυτήν την τεκμηρίωση σε έναν σχεδιασμό και εκτελεί τον ίδιο έλεγχο εγκυρότητας που εφαρμόζει ο σχεδιαστής API, εξ ολοκλήρου στο παρασκήνιο. Δεν μπλοκάρει ποτέ την εισαγωγή και δεν διακόπτει ποτέ αυτό που κάνετε.

Αν δεν βρει τίποτα, δεν βλέπετε τίποτα. Αν βρει δομικά προβλήματα, σας τα υποδεικνύει σε δύο σημεία.

Το «!» στην πλαϊνή μπάρα

Ο φάκελος μεταβλητών που φέρει το επισημασμένο API εμφανίζει ένα μικρό «!» στα δεξιά της γραμμής του. Είναι το σήμα με μια ματιά ότι ο σχεδιασμός αυτού του API αξίζει μια ματιά — και εξαφανίζεται από μόνο του μόλις το API γίνει ξανά καθαρό (μετά από μια νέα εισαγωγή ή μια ενημέρωση του API που το διορθώνει).

Η καρτέλα «Προβλήματα»

Ανοίξτε τον φάκελο μεταβλητών και αποκτά μια καρτέλα «Προβλήματα». Η καρτέλα εμφανίζεται μόνο όταν εντοπίστηκαν προβλήματα — ένα καθαρό API δεν την εμφανίζει ποτέ.

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

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

• διπλότυπες διαδρομές — δύο διαδρομές που απαντούν στην ίδια μέθοδο και διαδρομή·
• απουσία αποκρίσεων — μια διαδρομή που δεν δηλώνει καμία απόκριση·
• δεσμευμένες διαδρομές — μια διαδρομή που βρίσκεται σε μια διαδρομή την οποία δεσμεύει ο Mock Server (/swagger.json, /graphql, …) και που δεν θα απαντούσε ποτέ·
• προβλήματα περιορισμών — ένα μη έγκυρο μοτίβο ή ένα ελάχιστο μεγαλύτερο από το μέγιστό του.

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