Import modelu Smithy
Smithy to język modelowania API opracowany przez AWS. Restorm importuje obie jego reprezentacje.
Importowanie
Section titled “Importowanie”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.
Co zostaje zaimportowane
Section titled “Co zostaje zaimportowane”| Element | Co Restorm z tego tworzy |
|---|---|
Każdy service / resource | Folder |
Każda operacja z cechą @http | Żądanie HTTP |
@httpLabel | Parametr ścieżki |
@httpQuery | Parametr zapytania |
@httpHeader | Nagłówek |
| Dokumentacja i typy | Dokumentacja API oraz wyliczenia |
Ograniczenia (wersja 1 importu)
Section titled “Ograniczenia (wersja 1 importu)”- Operacja bez cechy
@httpma 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.
Aktualizacja
Section titled “Aktualizacja”Smithy należy do formatów, które można ponownie zsynchronizować. Zob. Aktualizacja ze źródła.