Importar um modelo Smithy
O Smithy é a linguagem de modelação de API da AWS. O Restorm importa as suas duas representações.
Importar
Section titled “Importar”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.
O que é importado
Section titled “O que é importado”| Elemento | O que o Restorm faz com ele |
|---|---|
Cada service / resource | Uma pasta |
Cada operação com @http | Um pedido HTTP |
@httpLabel | Um parâmetro de caminho |
@httpQuery | Um parâmetro de consulta |
@httpHeader | Um cabeçalho |
| Documentação e tipos | A documentação de API e as enumerações |
Limites (versão 1 da importação)
Section titled “Limites (versão 1 da importação)”- 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.
Atualizar
Section titled “Atualizar”O Smithy faz parte dos formatos ressincronizáveis. Consulte Atualizar a partir da origem.