Przejdź do głównej zawartości

Import modelu Smithy

Smithy to język modelowania API opracowany przez AWS. Restorm importuje obie jego reprezentacje.

Plik ▸ Importuj (Ctrl+I), a następnie:

  • plik .smithy (język modelowania);
  • albo AST JSON wytworzony przez smithy build.

Oba prowadzą do tego samego modelu wewnętrznego.

ElementCo Restorm z tego tworzy
Każdy service / resourceFolder
Każda operacja z cechą @httpŻądanie HTTP
@httpLabelParametr ścieżki
@httpQueryParametr zapytania
@httpHeaderNagłówek
Dokumentacja i typyDokumentacja API oraz wyliczenia
  • Operacja bez cechy @http ma charakter wyłącznie dokumentacyjny: pojawia się w dokumentacji API, ale nie tworzy żądania.
  • Uwierzytelnianie SigV4 nie jest wstępnie podłączone: trzeba je skonfigurować ręcznie.
  • Powiązania protokołów innych niż REST (awsJson1_1, awsQuery…) nie są modelowane.
  • Listy, słowniki i unie nie są strukturami pierwszej kategorii.
  • Cechy walidacyjne (@pattern, @length, @paginated, @readonly…) są po cichu pomijane.
  • Testy protokołu Smithy są pomijane.

Smithy należy do formatów, które można ponownie zsynchronizować. Zob. Aktualizacja ze źródła.