Sari la conținut

Importarea unui model Smithy

Smithy este limbajul de modelare a API-urilor de la AWS. Restorm importă ambele reprezentări ale sale.

Fișier ▸ Importă (Ctrl+I), apoi:

  • un fișier .smithy (limbajul de modelare);
  • sau AST-ul JSON produs de smithy build.

Amândouă converg spre același model interior.

ElementCe face Restorm cu el
Fiecare service / resourceUn folder
Fiecare operațiune care poartă @httpO cerere HTTP
@httpLabelUn parametru de cale
@httpQueryUn parametru de interogare
@httpHeaderUn antet
Documentație și tipuriDocumentația de API și enumerările
  • O operațiune fără trăsătura @http este doar documentară: apare în documentația de API, dar nu produce nicio cerere.
  • Autentificarea SigV4 nu este precablată: configurați-o manual.
  • Legăturile de protocol non-REST (awsJson1_1, awsQuery…) nu sunt modelate.
  • Listele, dicționarele și uniunile nu sunt forme de prim rang.
  • Trăsăturile de validare (@pattern, @length, @paginated, @readonly…) sunt ignorate în mod silențios.
  • Testele de protocol Smithy sunt ignorate.

Smithy face parte dintre formatele re-sincronizabile. Vedeți Actualizarea din sursă.