Salta ai contenuti

Importare un modello Smithy

Smithy è il linguaggio di modellazione di API di AWS. Restorm ne importa entrambe le rappresentazioni.

File ▸ Importa (Ctrl+I) e poi:

  • un file .smithy (il linguaggio di modellazione);
  • oppure l’AST JSON prodotto da smithy build.

Entrambi convergono verso lo stesso modello interno.

ElementoCiò che Restorm ne fa
Ogni service / resourceUna cartella
Ogni operazione che porta @httpUna richiesta HTTP
@httpLabelUn parametro di percorso
@httpQueryUn parametro di query
@httpHeaderUn header
Documentazione e tipiLa documentazione di API e le enumerazioni
  • Un’operazione senza trait @http è soltanto documentale: compare nella documentazione di API ma non produce una richiesta.
  • L’autenticazione SigV4 non è precablata: va configurata a mano.
  • I binding di protocollo non REST (awsJson1_1, awsQuery…) non sono modellati.
  • Elenchi, dizionari e union non sono forme di primo piano.
  • I trait di validazione (@pattern, @length, @paginated, @readonly…) vengono ignorati in silenzio.
  • I test di protocollo Smithy vengono ignorati.

Smithy fa parte dei formati risincronizzabili. Si veda Aggiornare dalla sorgente.