Εισαγωγή OpenAPI / Swagger

Είναι η πληρέστερη εισαγωγή του Restorm. Αναγνωρίζονται τρεις εκδόσεις: Swagger 2.0, OpenAPI 3.0 και OpenAPI 3.1.

Εισαγωγή

Αρχείο ▸ Εισαγωγή (Ctrl+I), έπειτα ένα αρχείο swagger.json / openapi.json, ή απευθείας η διεύθυνση URL της προδιαγραφής.

Αν η διεύθυνση URL απαντήσει 401 ή 403, το Restorm σας προτείνει να συνδέσετε μια ταυτοποίηση και να ξαναπροσπαθήσετε, χωρίς να φύγετε από το παράθυρο διαλόγου εισαγωγής.

Τι εισάγεται

Στοιχείο της προδιαγραφής	Τι κάνει το Restorm με αυτό
servers (ή host + basePath + schemes)	Τη βασική διεύθυνση URL του περιβάλλοντος, με τις μεταβλητές διακομιστή επιλυμένες
tags	Έναν φάκελο ανά ετικέτα, συν έναν φάκελο Other για τα υπόλοιπα
Κάθε λειτουργία	Ένα αίτημα HTTP, μαζί με τη μέθοδο και τη διαδρομή
Παράμετροι	Παραμέτρους διαδρομής, ερωτήματος και κεφαλίδες, με τύπους (συμβολοσειρά, αριθμός, ημερομηνία-ώρα, απαρίθμηση, μυστικό…)
requestBody	Το σώμα, στον τύπο περιεχομένου του
examples	Το σώμα προσυμπληρωμένο με το παρεχόμενο παράδειγμα
components / definitions	Την τεκμηρίωση API: μοντέλα, περιγραφές
enum	Απαριθμήσεις επαναχρησιμοποιήσιμες ως τύπος τιμής
Αποκρίσεις	Τεκμηριωμένες ανά τύπο περιεχομένου

Τα $ref επιλύονται, ακόμη και μέσα από τα components.

Η γραμμή components / definitions αξίζει να τονιστεί: η εισαγωγή δεν περιορίζεται στα αιτήματα, διατηρεί ολόκληρη την τεκμηρίωση του API — περιγραφές, μοντέλα, σχήματα ασφαλείας, παραδείγματα, απαριθμήσεις. Είναι προσβάσιμη στην καρτέλα Docs του φακέλου μεταβλητών που προέκυψε από την εισαγωγή, όπως και σε εκείνη κάθε αιτήματος, και επανασυγχρονίζεται από την πηγή. Δείτε Πρόσβαση και ενημέρωση της τεκμηρίωσης ενός εισαγόμενου API.

Ασφάλεια

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

Σχήμα	Τι θέτει το Restorm
apiKey σε κεφαλίδα ή σε ερώτημα	Ένα ζεύγος με το όνομα του σχήματος, τιμή {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnect	Authorization: Bearer {{<schema>_token}}

Το μόνο που μένει είναι να συμπληρώσετε τη μεταβλητή — ή να την αντικαταστήσετε με μια διαδρομή ταυτοποίησης για να επωφεληθείτε από την αυτόματη ανανέωση.

Γνωστοί περιορισμοί

Τα apiKey που μεταδίδονται μέσω cookie δεν προκαλωδιώνονται (OpenAPI 3). Ένα σχήμα ασφαλείας που αναφέρεται αλλά δεν δηλώνεται αγνοείται σιωπηλά.

Ενημέρωση

Το OpenAPI και το Swagger συγκαταλέγονται στις επανασυγχρονίσιμες μορφές: το κουμπί Ανανέωση του φακέλου ανακτά την πηγή και το Restorm εφαρμόζει τη διαφορά — νέες λειτουργίες προστίθενται, λειτουργίες που εξαφανίστηκαν σημαίνονται ως παρωχημένες αντί να διαγραφούν, οι τροποποιήσεις σας διατηρούνται. Δείτε Ενημέρωση από την πηγή.