Zum Inhalt springen

Ein Smithy-Modell importieren

Smithy ist AWS’ Modellierungssprache für APIs. Restorm importiert beide Darstellungen.

Datei ▸ Importieren (Ctrl+I), dann:

  • eine .smithy-Datei (die Modellierungssprache);
  • oder das von smithy build erzeugte AST-JSON.

Beide laufen im selben internen Modell zusammen.

ElementWas Restorm daraus macht
Jeder service / resourceEin Ordner
Jede Operation mit @httpEine HTTP-Anfrage
@httpLabelEin Pfadparameter
@httpQueryEin Anfrageparameter
@httpHeaderEin Header
Dokumentation und TypenDie API-Dokumentation und die Aufzählungen
  • 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.

Smithy gehört zu den neu synchronisierbaren Formaten. Siehe Aktualisierung aus der Quelle.