Εισαγωγή ενός API
Το Restorm αναγνωρίζει είκοσι τέσσερις μορφές και ανακατασκευάζει από αυτές ένα πλήρες δέντρο έργου: φακέλους, αιτήματα, περιβάλλοντα, τεκμηρίωση API, απαριθμήσεις.
Είναι σχεδόν πάντα το καλύτερο σημείο εκκίνησης: μη γράφετε τα αιτήματά σας στο χέρι αν υπάρχει προδιαγραφή.
Πώς γίνεται η εισαγωγή
Section titled “Πώς γίνεται η εισαγωγή”Το Αρχείο ▸ Εισαγωγή (Ctrl+I) δέχεται:
- ένα αρχείο του δίσκου·
- μια διεύθυνση URL — χρήσιμο για ένα
swagger.jsonή ένα$metadataπου σερβίρεται διαδικτυακά· - επικολλημένο περιεχόμενο — έτσι μετατρέπεται μια εντολή
curlσε αίτημα.
Το Restorm εντοπίζει τη μορφή μόνο του: πρώτα από την επέκταση του αρχείου, έπειτα αναλύοντας το περιεχόμενο. Δεν έχετε να επιλέξετε τίποτα.
Οι μορφές
Section titled “Οι μορφές”Προδιαγραφές API
Section titled “Προδιαγραφές API”| Μορφή | Σελίδα |
|---|---|
| OpenAPI 3.x και Swagger 2.0 | OpenAPI / Swagger |
| Σχήμα GraphQL (SDL) | GraphQL |
Αρχεία .proto και αντανάκλαση gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Σχήμα tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Συλλογές άλλων πελατών
Section titled “Συλλογές άλλων πελατών”| Μορφή | Σελίδα |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Καταγραφές και γραμμές εντολών
Section titled “Καταγραφές και γραμμές εντολών”| Μορφή | Σελίδα |
|---|---|
| HAR (καταγραφή περιηγητή) | HAR |
Εντολές curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Τι λαμβάνετε
Section titled “Τι λαμβάνετε”Ανάλογα με τον πλούτο της μορφής προέλευσης:
- έναν φάκελο μεταβλητών με ένα ή περισσότερα περιβάλλοντα, με τη βασική διεύθυνση URL εξαγμένη από την προδιαγραφή·
- μια δενδρική δομή φακέλων — ανά ετικέτα, ανά υπηρεσία, ανά πόρο ανάλογα με τη μορφή·
- ένα αίτημα ανά λειτουργία, του τύπου που αντιστοιχεί στο πρωτόκολλο·
- την τεκμηρίωση API συνδεδεμένη με τον φάκελο: μοντέλα, περιγραφές, σχήματα ασφαλείας, δείγματα αποκρίσεων·
- τις απαριθμήσεις της προδιαγραφής, επαναχρησιμοποιήσιμες ως τύπος τιμής·
- τις προκαλωδιωμένες κεφαλίδες ταυτοποίησης με τις μεταβλητές τους — δείτε Ταυτοποίηση.
Μετά την εισαγωγή, κάθε ζεύγος κλειδιού / τιμής του οποίου η τιμή επιλύεται σε κενό απενεργοποιείται αυτόματα: η πρώτη σας αποστολή δεν φεύγει επομένως με ένα πλήθος κενών κεφαλίδων.
Η τεκμηρίωση του εισαγόμενου API
Section titled “Η τεκμηρίωση του εισαγόμενου API”Μια εισαγωγή δεν παράγει μόνο αιτήματα: διατηρεί την τεκμηρίωση του API — περιγραφές, μοντέλα, ασφάλεια, παραδείγματα, απαριθμήσεις — που είναι προσβάσιμη στην καρτέλα Docs του φακέλου που δημιουργήθηκε. Δείτε Πρόσβαση και ενημέρωση της τεκμηρίωσης ενός εισαγόμενου API.
Ενημέρωση μιας εισαγωγής
Section titled “Ενημέρωση μιας εισαγωγής”Δώδεκα μορφές δέχονται επανασυγχρονισμό: το Restorm συγκρίνει τη νέα έκδοση της πηγής με το υπάρχον δέντρο και εφαρμόζει τη διαφορά, χωρίς να χάσει τις τροποποιήσεις σας. Δείτε Ενημέρωση από την πηγή.
Και η εξαγωγή;
Section titled “Και η εξαγωγή;”Το Restorm παράγει αποσπάσματα κώδικα για κάθε αίτημα, σε όλες τις γλώσσες που είναι σχετικές με το πρωτόκολλό του. Δείτε Εξαγωγή κώδικα.