Gå til innholdet

Importere en Smithy-modell

Smithy er AWS’ modelleringsspråk for API-er. Restorm importerer begge representasjonene.

Fil ▸ Importer (Ctrl+I), og deretter:

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

Begge ender opp i samme interne modell.

ElementHva Restorm gjør med det
Hver service / resourceEn mappe
Hver operasjon med @httpEn HTTP-forespørsel
@httpLabelEn stiparameter
@httpQueryEn spørringsparameter
@httpHeaderEn header
Dokumentasjon og typerAPI-dokumentasjonen og enumerasjonene
  • En operasjon uten @http-trait er kun dokumenterende: den vises i API-dokumentasjonen, men gir ingen forespørsel.
  • Autentisering med SigV4 blir ikke ferdigkoblet: sett den opp for hånd.
  • Protokollbindinger som ikke er REST (awsJson1_1, awsQuery …) er ikke modellert.
  • Lister, oppslagstabeller og unioner er ikke førsteklasses former.
  • Valideringstraits (@pattern, @length, @paginated, @readonly …) ignoreres stille.
  • Smithys protokolltester ignoreres.

Smithy er blant formatene som kan synkroniseres på nytt. Se Oppdatere fra kilden.