Ein Smithy-Modell importieren
Smithy ist AWS’ Modellierungssprache für APIs. Restorm importiert beide Darstellungen.
Importieren
Section titled “Importieren”Datei ▸ Importieren (Ctrl+I), dann:
- eine
.smithy-Datei (die Modellierungssprache); - oder das von
smithy builderzeugte AST-JSON.
Beide laufen im selben internen Modell zusammen.
Was importiert wird
Section titled “Was importiert wird”| Element | Was Restorm daraus macht |
|---|---|
Jeder service / resource | Ein Ordner |
Jede Operation mit @http | Eine HTTP-Anfrage |
@httpLabel | Ein Pfadparameter |
@httpQuery | Ein Anfrageparameter |
@httpHeader | Ein Header |
| Dokumentation und Typen | Die API-Dokumentation und die Aufzählungen |
Einschränkungen (Version 1 des Imports)
Section titled “Einschränkungen (Version 1 des Imports)”- Eine Operation ohne
@http-Trait ist rein dokumentarisch: Sie erscheint in der API-Dokumentation, erzeugt aber keine Anfrage. - SigV4-Authentifizierung ist nicht vorverdrahtet: Konfigurieren Sie sie manuell.
- Nicht-REST-Protokollbindungen (
awsJson1_1,awsQuery…) werden nicht modelliert. - Listen, Dictionaries und Unions sind keine eigenständigen Formen.
- Validierungs-Traits (
@pattern,@length,@paginated,@readonly…) werden stillschweigend ignoriert. - Smithy-Protokolltests werden ignoriert.
Aktualisieren
Section titled “Aktualisieren”Smithy gehört zu den neu synchronisierbaren Formaten. Siehe Aktualisierung aus der Quelle.