Siirry sisältöön

Smithy-mallin tuonti

Smithy on AWS:n API-mallinnuskieli. Restorm tuo siitä molemmat esitysmuodot.

Tiedosto ▸ Tuo (Ctrl+I) ja sitten:

  • .smithy-tiedosto (mallinnuskieli);
  • tai JSON AST, jonka smithy build tuottaa.

Molemmat päätyvät samaan sisäiseen malliin.

ElementtiMitä Restorm tekee siitä
Jokainen service / resourceKansio
Jokainen operaatio, jolla on @httpHTTP-pyyntö
@httpLabelPolkuparametri
@httpQueryKyselyparametri
@httpHeaderOtsake
Dokumentaatio ja tyypitAPI-dokumentaatio ja luettelotyypit
  • Operaatio ilman @http-piirrettä on vain dokumentaatiota: se näkyy API-dokumentaatiossa mutta ei tuota pyyntöä.
  • SigV4-todennusta ei kytketä valmiiksi: määritä se käsin.
  • Muita kuin REST-protokollasidontoja (awsJson1_1, awsQuery…) ei mallinneta.
  • Luettelot, sanakirjat ja unionit eivät ole ensiluokkaisia muotoja.
  • Validointipiirteet (@pattern, @length, @paginated, @readonly…) ohitetaan hiljaisesti.
  • Smithyn protokollatestit ohitetaan.

Smithy kuuluu uudelleen synkronoitaviin muotoihin. Katso Päivitys lähteestä.