Import modelu Smithy
Smithy je modelovací jazyk pro API od AWS. Restorm importuje obě jeho podoby.
Import
Section titled “Import”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.
Co se importuje
Section titled “Co se importuje”| Prvek | Co s ním Restorm udělá |
|---|---|
Každá service / resource | Složka |
Každá operace s @http | Požadavek HTTP |
@httpLabel | Parametr cesty |
@httpQuery | Parametr dotazu |
@httpHeader | Hlavička |
| Dokumentace a typy | Dokumentace API a výčtové typy |
Omezení (verze 1 importu)
Section titled “Omezení (verze 1 importu)”- Operace bez rysu
@httpje 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í.
Aktualizace
Section titled “Aktualizace”Smithy patří mezi formáty, které lze znovu synchronizovat. Viz Aktualizace ze zdroje.