Ir al contenido

Importar un modelo de Smithy

Smithy es el lenguaje de modelado de API de AWS. Restorm importa sus dos representaciones.

Archivo ▸ Importar (Ctrl+I) y después:

  • un archivo .smithy (el lenguaje de modelado);
  • o el AST JSON producido por smithy build.

Ambos convergen en el mismo modelo interno.

ElementoLo que Restorm hace con él
Cada service / resourceUna carpeta
Cada operación con @httpUna petición HTTP
@httpLabelUn parámetro de ruta
@httpQueryUn parámetro de consulta
@httpHeaderUna cabecera
Documentación y tiposLa documentación de API y las enumeraciones
  • Una operación sin el rasgo @http es solo documental: aparece en la documentación de API pero no produce ninguna petición.
  • La autenticación SigV4 no se preconfigura: configúrela a mano.
  • Las vinculaciones de protocolo no REST (awsJson1_1, awsQuery…) no se modelan.
  • Las listas, los diccionarios y las uniones no son formas de primer nivel.
  • Los rasgos de validación (@pattern, @length, @paginated, @readonly…) se ignoran en silencio.
  • Las pruebas de protocolo de Smithy se ignoran.

Smithy forma parte de los formatos resincronizables. Consulte Actualizar desde el origen.