Προβολέας OpenAPI / Swagger

Απόδοση εγγράφου OpenAPI 3.0 / 3.1 ή Swagger 2.0 (YAML ή JSON) σε αναζητήσιμη αναφορά API — πληροφορίες, διακομιστές, διαδρομές με ετικέτες, παράμετροι, παραδείγματα σώματος αιτήματος που παράγονται από σχήματα, απαντήσεις και ασφάλεια. Ανάπτυξη οποιασδήποτε λειτουργίας με Try it και αποστολή ζωντανού αιτήματος από το πρόγραμμα περιήγησης, ή εξαγωγή ως cURL. Τα έγγραφα αναλύονται τοπικά· οι απομακρυσμένοι στόχοι $ref και τα εξωτερικά σχήματα δεν λαμβάνονται (πλήρως τοπικά). Αν προτιμάται αντίθετα ένας διαδραστικός συντάκτης αιτημάτων, βλ. τον Πελάτη / δοκιμαστή REST API και ολόκληρη την οικογένεια Εργαλείων API.
Έγγραφο OpenAPI / Swagger
Δοκιμή
Παράμετροι
Σχετικά με αυτόν τον προβολέα: υποστηρίζει Swagger 2.0 και OpenAPI 3.0 / 3.1. Οι αναφορές επιλύονται μόνο μέσα στο έγγραφο (#/components/schemas/…, #/definitions/…)· οι εξωτερικές αναφορές σε αρχείο ή URL επισημαίνονται αλλά δεν λαμβάνονται. Οι κλήσεις Try it υπόκεινται στην πολιτική CORS του διακομιστή-στόχου — αν μια κλήση μπλοκάρεται, χρήση του Μετατροπέα cURL ή του REST Client για εκτέλεση εκτός του περιβάλλοντος ασφαλείας του προγράμματος περιήγησης.
OpenAPI έναντι Swagger, v2 έναντι v3

Το Swagger ήταν το αρχικό όνομα των εργαλείων· όταν η προδιαγραφή δόθηκε στο Linux Foundation το 2015, έγινε OpenAPI, και το Swagger συνεχίζει ως εμπορικό σήμα εργαλείων. Ένα έγγραφο χτίζεται από info (μεταδεδομένα), paths (λειτουργίες ανά σημείο πρόσβασης) και components (επαναχρησιμοποιήσιμα σχήματα).

Το κλειδί έκδοσης δείχνει στους προβολείς ποιον αναλυτή να χρησιμοποιήσουν: swagger: "2.0" έναντι openapi: 3.0.x — η v3 μετέφερε τα σώματα αιτημάτων έξω από τις παραμέτρους και υιοθέτησε πραγματικό JSON Schema.