Een Smithy-model importeren

Smithy is de modelleertaal voor API’s van AWS. Restorm importeert beide representaties daarvan.

Importeren

Bestand ▸ Importeren (Ctrl+I) en daarna:

• een .smithy-bestand (de modelleertaal);
• of de JSON-AST die smithy build oplevert.

Beide komen op hetzelfde interne model uit.

Wat er wordt geïmporteerd

Element	Wat Restorm daarmee doet
Elke service / resource	Een map
Elke operatie met @http	Een HTTP-verzoek
@httpLabel	Een padparameter
@httpQuery	Een queryparameter
@httpHeader	Een header
Documentatie en typen	De API-documentatie en de enumeraties

Beperkingen (versie 1 van de import)

• Een operatie zonder trait @http is uitsluitend documentair: zij verschijnt in de API-documentatie maar levert geen verzoek op.
• De SigV4-authenticatie wordt niet voorgeschakeld: stel die met de hand in.
• De niet-REST-protocolbindings (awsJson1_1, awsQuery…) worden niet gemodelleerd.
• Lijsten, dictionaries en unions zijn geen eersteklas vormen.
• De validatietraits (@pattern, @length, @paginated, @readonly…) worden stil overgeslagen.
• De Smithy-protocoltests worden overgeslagen.

Bijwerken

Smithy hoort bij de formaten die opnieuw te synchroniseren zijn. Zie Bijwerken vanaf de bron.