Přeskočit na obsah

Import modelu Smithy

Smithy je modelovací jazyk pro API od AWS. Restorm importuje obě jeho podoby.

Soubor ▸ Importovat (Ctrl+I) a poté:

  • soubor .smithy (modelovací jazyk);
  • nebo AST JSON vytvořený příkazem smithy build.

Obě cesty vedou ke stejnému vnitřnímu modelu.

PrvekCo s ním Restorm udělá
Každá service / resourceSložka
Každá operace s @httpPožadavek HTTP
@httpLabelParametr cesty
@httpQueryParametr dotazu
@httpHeaderHlavička
Dokumentace a typyDokumentace API a výčtové typy
  • Operace bez rysu @http je pouze dokumentační: objeví se v dokumentaci API, ale nevytvoří požadavek.
  • Ověřování SigV4 není předem zapojeno: nastavte si ho ručně.
  • Vazby na jiné protokoly než REST (awsJson1_1, awsQuery…) nejsou namodelované.
  • Seznamy, slovníky a sjednocení nejsou prvořadé tvary.
  • Validační rysy (@pattern, @length, @paginated, @readonly…) se tiše ignorují.
  • Protokolové testy Smithy se ignorují.

Smithy patří mezi formáty, které lze znovu synchronizovat. Viz Aktualizace ze zdroje.