Aller au contenu

Importer un modèle Smithy

Smithy est le langage de modélisation d’API d’AWS. Restorm en importe les deux représentations.

Fichier ▸ Importer (Ctrl+I) puis :

  • un fichier .smithy (le langage de modélisation) ;
  • ou l’AST JSON produit par smithy build.

Les deux convergent vers le même modèle interne.

ÉlémentCe que Restorm en fait
Chaque service / resourceUn dossier
Chaque opération portant @httpUne requête HTTP
@httpLabelUn paramètre de chemin
@httpQueryUn paramètre de requête
@httpHeaderUn en-tête
Documentation et typesLa documentation d’API et les énumérations
  • Une opération sans trait @http est documentaire uniquement : elle apparaît dans la documentation d’API mais ne produit pas de requête.
  • L’authentification SigV4 n’est pas pré-câblée : configurez-la à la main.
  • Les liaisons de protocole non-REST (awsJson1_1, awsQuery…) ne sont pas modélisées.
  • Les listes, dictionnaires et unions ne sont pas des formes de premier plan.
  • Les traits de validation (@pattern, @length, @paginated, @readonly…) sont ignorés silencieusement.
  • Les tests de protocole Smithy sont ignorés.

Smithy fait partie des formats re-synchronisables. Voir Mettre à jour depuis la source.