Aller au contenu

Importer OpenAPI / Swagger

C’est l’import le plus complet de Restorm. Trois versions sont reconnues : Swagger 2.0, OpenAPI 3.0 et OpenAPI 3.1.

Fichier ▸ Importer (Ctrl+I), puis un fichier swagger.json / openapi.json, ou directement l’URL de la spécification.

Si l’URL répond 401 ou 403, Restorm vous propose d’attacher une authentification et de réessayer, sans quitter la modale d’import.

L'arbre produit par un import OpenAPI dans le volet latéral — un dossier par étiquette (pet, store, user) — à côté du sous-onglet d'accueil du dossier de variables

Élément de la spécificationCe que Restorm en fait
servers (ou host + basePath + schemes)L’URL de base de l’environnement, variables de serveur résolues
tagsUn dossier par étiquette, plus un dossier Other pour le reste
Chaque opérationUne requête HTTP, méthode et chemin compris
ParamètresParamètres de chemin, de requête et en-têtes, typés (chaîne, nombre, date-heure, énumération, secret…)
requestBodyLe corps, dans son type de contenu
examplesLe corps pré-rempli avec l’exemple fourni
components / definitionsLa documentation d’API : modèles, descriptions
enumDes énumérations réutilisables comme type de valeur
RéponsesDocumentées par type de contenu

Les $ref sont résolus, y compris à travers les composants.

La ligne components / definitions mérite d’être soulignée : l’import ne se limite pas aux requêtes, il conserve toute la documentation de l’API — descriptions, modèles, schémas de sécurité, exemples, énumérations. Elle est consultable dans l’onglet Docs du dossier de variables issu de l’import comme dans celui de chaque requête, et se resynchronise depuis la source. Voir Accès et mise à jour de la documentation d’une API importée.

L'onglet Docs du dossier de variables issu de l'import, avec la documentation de l'API et son sommaire

Les schémas de sécurité déclarés sont traduits en en-têtes ou paramètres pré-câblés, avec la variable d’environnement correspondante créée pour vous :

SchémaCe que Restorm pose
apiKey en en-tête ou en requêteUn couple nommé d’après le schéma, valeur {{<schema>}}
http + basicAuthorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnectAuthorization: Bearer {{<schema>_token}}

Il ne reste qu’à renseigner la variable — ou à la remplacer par une route d’authentification pour bénéficier du renouvellement automatique.

OpenAPI et Swagger figurent parmi les formats re-synchronisables : le bouton Actualiser du dossier récupère la source et Restorm applique le delta — nouvelles opérations ajoutées, opérations disparues marquées dépréciées plutôt que supprimées, vos modifications conservées. Voir Mettre à jour depuis la source.