Εισαγωγή ενός μοντέλου Smithy
Το Smithy είναι η γλώσσα μοντελοποίησης API της AWS. Το Restorm εισάγει και τις δύο αναπαραστάσεις του.
Εισαγωγή
Section titled “Εισαγωγή”Αρχείο ▸ Εισαγωγή (Ctrl+I) και έπειτα:
- ένα αρχείο
.smithy(τη γλώσσα μοντελοποίησης)· - ή το AST JSON που παράγεται από το
smithy build.
Και τα δύο συγκλίνουν στο ίδιο εσωτερικό μοντέλο.
Τι εισάγεται
Section titled “Τι εισάγεται”| Στοιχείο | Τι κάνει το Restorm με αυτό |
|---|---|
Κάθε service / resource | Έναν φάκελο |
Κάθε λειτουργία που φέρει @http | Ένα αίτημα HTTP |
@httpLabel | Μια παράμετρο διαδρομής |
@httpQuery | Μια παράμετρο ερωτήματος |
@httpHeader | Μια κεφαλίδα |
| Τεκμηρίωση και τύπους | Την τεκμηρίωση API και τις απαριθμήσεις |
Περιορισμοί (έκδοση 1 της εισαγωγής)
Section titled “Περιορισμοί (έκδοση 1 της εισαγωγής)”- Μια λειτουργία χωρίς χαρακτηριστικό
@httpείναι μόνο τεκμηριωτική: εμφανίζεται στην τεκμηρίωση API αλλά δεν παράγει αίτημα. - Η ταυτοποίηση SigV4 δεν προκαλωδιώνεται: ρυθμίστε την στο χέρι.
- Οι μη REST συνδέσεις πρωτοκόλλου (
awsJson1_1,awsQuery…) δεν μοντελοποιούνται. - Οι λίστες, τα λεξικά και οι ενώσεις δεν είναι μορφές πρώτης γραμμής.
- Τα χαρακτηριστικά επικύρωσης (
@pattern,@length,@paginated,@readonly…) αγνοούνται σιωπηλά. - Οι δοκιμές πρωτοκόλλου Smithy αγνοούνται.
Ενημέρωση
Section titled “Ενημέρωση”Το Smithy ανήκει στις επανασυγχρονίσιμες μορφές. Δείτε Ενημέρωση από την πηγή.