Σχετικά με Προβολέας προδιαγραφών OpenAPI — Αναλυτικός οδηγός
Ο OpenAPI Viewer είναι ένα πρόγραμμα ανάγνωσης τεκμηρίωσης στην πλευρά του πελάτη (client-side) για την επιθεώρηση συμβολαίων RESTful API. Αποδίδει προδιαγραφές Swagger 2.0 και OpenAPI 3.0 / 3.1 σε μορφή JSON ή YAML χωρίς να απαιτεί τοπικές εγκαταστάσεις του Swagger UI ή εξαρτήσεις από το cloud.
Προσφέρει καθαρή, ομαδοποιημένη πλοήγηση στην πλευρική γραμμή για όλα τα endpoints, εμφανίζοντας διαδρομές (paths), μεθόδους HTTP (GET, POST, PUT, DELETE), παραμέτρους κεφαλίδων (headers), query strings, δομημένα σώματα αιτημάτων (request bodies), κωδικούς απόκρισης HTTP και σχήματα δεδομένων.
Βασικά χαρακτηριστικά και δυνατότητες
- Υποστηρίζει προδιαγραφές Swagger 2.0 και OpenAPI 3.0 / 3.1 σε JSON και YAML
- Διαδραστική πλευρική γραμμή με κατηγοριοποιημένα endpoints, μεθόδους HTTP και κωδικούς κατάστασης
- Σε βάθος επίλυση σχημάτων `$ref` με προβολή ένθετων μοντέλων δεδομένων και περιορισμών ιδιοτήτων
- 100% συντακτική ανάλυση χωρίς σύνδεση (offline) στην πλευρά του πελάτη, διατηρώντας ασφαλή τα ιδιόκτητα εταιρικά συμβόλαια API
Τρόπος χρήσης
- 1
Επικολλήστε το κείμενο του `swagger.json` ή `openapi.yaml`, ή μεταφορτώστε απευθείας το αρχείο προδιαγραφών.
- 2
Περιηγηθείτε στη δομημένη τεκμηρίωση του API που αποδίδεται στο διαδραστικό πρόγραμμα προβολής.
- 3
Αναπτύξτε οποιοδήποτε endpoint για να επιθεωρήσετε κεφαλίδες αιτημάτων, σχήματα ωφέλιμου φορτίου (payload) και δείγματα αποκρίσεων.
Συνήθεις περιπτώσεις χρήσης
- → Έλεγχος ορισμών backend API χωρίς την ανάγκη εγκατάστασης και διαμόρφωσης αποκλειστικού διακομιστή Swagger UI
- → Έλεγχος ορθότητας χειρόγραφων προδιαγραφών OpenAPI για τον εντοπισμό μη έγκυρων δεικτών `$ref`
- → Παροχή ακριβών αναφορών σχημάτων σε μηχανικούς frontend κατά την ενσωμάτωση API
Σχετικά εργαλεία
Γεννήτρια ετικετών Meta
Δημιουργήστε ετικέτες meta HTML για SEO, Open Graph και Twitter Cards.
Γεννήτρια αρχείων .gitignore
Δημιουργήστε προσαρμοσμένα αρχεία .gitignore για τα έργα και τα περιβάλλοντα ανάπτυξής σας.
Γεννήτρια αδειών ανοιχτού κώδικα
Επιλέξτε και δημιουργήστε κείμενα αδειών ανοιχτού κώδικα (MIT, Apache 2.0, GPL, BSD).
Γεννήτρια README.md
Δημιουργήστε πλήρη και δομημένα αρχεία README.md για έργα ανοιχτού κώδικα.
Γεννήτρια Conventional Commits
Συντάξτε μηνύματα commit σύμφωνα με την προδιαγραφή Conventional Commits.
Υπολογιστής SemVer
Επικυρώστε και υπολογίστε αυξήσεις σημασιολογικής έκδοσης (major, minor, patch).
Συχνές ερωτήσεις και απόρρητο
Μπορεί αυτό το εργαλείο να διαβάσει απευθείας προδιαγραφές YAML;
Ναι. Ένας ενσωματωμένος αναλυτής YAML επεξεργάζεται τόσο αρχεία προδιαγραφών συμβολαίου OpenAPI `.yaml` όσο και `.json` εξ ολοκλήρου μέσα στο πρόγραμμα περιήγησης.
Μεταφορτώνεται η ιδιόκτητη προδιαγραφή του API μου σε εξωτερικούς διακομιστές;
Όχι. Όλη η συντακτική ανάλυση του εγγράφου και η απόδοση των σχημάτων εκτελούνται αυστηρά στην τοπική μνήμη του προγράμματος περιήγησής σας.