Hoppa till innehåll

Importera en Smithy-modell

Smithy är AWS:s modelleringsspråk för API:er. Restorm importerar båda dess representationer.

Arkiv ▸ Importera (Ctrl+I) och sedan:

  • en .smithy-fil (modelleringsspråket);
  • eller det JSON-AST som smithy build skapar.

Båda mynnar ut i samma interna modell.

ElementVad Restorm gör av det
Varje service / resourceEn mapp
Varje operation som bär @httpEn HTTP-begäran
@httpLabelEn sökvägsparameter
@httpQueryEn frågeparameter
@httpHeaderEn header
Dokumentation och typerAPI-dokumentationen och uppräkningarna
  • En operation utan traiten @http är enbart dokumenterande: den syns i API-dokumentationen men ger ingen begäran.
  • Autentiseringen SigV4 kopplas inte in i förväg: konfigurera den för hand.
  • Protokollbindningar som inte är REST (awsJson1_1, awsQuery …) modelleras inte.
  • Listor, ordböcker och unioner är inte förstaklassiga former.
  • Valideringstraits (@pattern, @length, @paginated, @readonly …) ignoreras tyst.
  • Smithys protokolltester ignoreras.

Smithy är ett av de format som går att synkronisera om. Se Uppdatera från källan.