Pular para o conteúdo

Importar um modelo Smithy

O Smithy é a linguagem de modelação de API da AWS. O Restorm importa as suas duas representações.

Ficheiro ▸ Importar (Ctrl+I) e depois:

  • um ficheiro .smithy (a linguagem de modelação);
  • ou o AST JSON produzido por smithy build.

Ambos convergem para o mesmo modelo interno.

ElementoO que o Restorm faz com ele
Cada service / resourceUma pasta
Cada operação com @httpUm pedido HTTP
@httpLabelUm parâmetro de caminho
@httpQueryUm parâmetro de consulta
@httpHeaderUm cabeçalho
Documentação e tiposA documentação de API e as enumerações
  • Uma operação sem o trait @http é apenas documental: aparece na documentação de API mas não produz nenhum pedido.
  • A autenticação SigV4 não é preparada previamente: configure-a à mão.
  • As ligações de protocolo não-REST (awsJson1_1, awsQuery…) não são modeladas.
  • As listas, os dicionários e as uniões não são formas de primeiro plano.
  • Os traits de validação (@pattern, @length, @paginated, @readonly…) são ignorados silenciosamente.
  • Os testes de protocolo do Smithy são ignorados.

O Smithy faz parte dos formatos ressincronizáveis. Consulte Atualizar a partir da origem.