Importer un modèle Smithy
Smithy est le langage de modélisation d’API d’AWS. Restorm en importe les deux représentations.
Importer
Section titled “Importer”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.
Ce qui est importé
Section titled “Ce qui est importé”| Élément | Ce que Restorm en fait |
|---|---|
Chaque service / resource | Un dossier |
Chaque opération portant @http | Une requête HTTP |
@httpLabel | Un paramètre de chemin |
@httpQuery | Un paramètre de requête |
@httpHeader | Un en-tête |
| Documentation et types | La documentation d’API et les énumérations |
Limites (version 1 de l’import)
Section titled “Limites (version 1 de l’import)”- Une opération sans trait
@httpest 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.
Mettre à jour
Section titled “Mettre à jour”Smithy fait partie des formats re-synchronisables. Voir Mettre à jour depuis la source.