Importer une API
Restorm reconnaît vingt-quatre formats et reconstruit à partir d’eux un arbre de projet complet : dossiers, requêtes, environnements, documentation d’API, énumérations.
C’est presque toujours le meilleur point de départ : n’écrivez pas vos requêtes à la main si une spécification existe.
Comment importer
Section titled “Comment importer”Fichier ▸ Importer (Ctrl+I) accepte :
- un fichier du disque ;
- une URL — utile pour un
swagger.jsonou un$metadataservi en ligne ; - du contenu collé — c’est ainsi qu’on transforme une commande
curlen requête.
Restorm détecte le format tout seul : d’abord d’après l’extension du fichier, puis en analysant le contenu. Vous n’avez rien à choisir.
Les formats
Section titled “Les formats”Spécifications d’API
Section titled “Spécifications d’API”| Format | Page |
|---|---|
| OpenAPI 3.x et Swagger 2.0 | OpenAPI / Swagger |
| Schéma GraphQL (SDL) | GraphQL |
Fichiers .proto et réflexion gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Schéma tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Collections d’autres clients
Section titled “Collections d’autres clients”| Format | Page |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Captures et lignes de commande
Section titled “Captures et lignes de commande”| Format | Page |
|---|---|
| HAR (capture navigateur) | HAR |
Commandes curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Ce que vous obtenez
Section titled “Ce que vous obtenez”Selon la richesse du format source :
- un dossier de variables avec un ou plusieurs environnements, l’URL de base extraite de la spécification ;
- une arborescence de dossiers — par étiquette, par service, par ressource selon le format ;
- une requête par opération, du type correspondant au protocole ;
- la documentation d’API attachée au dossier : modèles, descriptions, schémas de sécurité, réponses d’exemple ;
- les énumérations de la spécification, réutilisables comme type de valeur ;
- les en-têtes d’authentification pré-câblés avec leurs variables — voir Authentification.
Après l’import, tout couple clé / valeur dont la valeur se résout à vide est automatiquement désactivé : votre premier envoi ne part donc pas avec une nuée d’en-têtes vides.
La documentation de l’API importée
Section titled “La documentation de l’API importée”Un import ne produit pas que des requêtes : il conserve la documentation de l’API — descriptions, modèles, sécurité, exemples, énumérations — consultable dans l’onglet Docs du dossier créé. Voir Accès et mise à jour de la documentation d’une API importée.
Mettre à jour un import
Section titled “Mettre à jour un import”Douze formats acceptent d’être re-synchronisés : Restorm compare la nouvelle version de la source à l’arbre existant et applique le delta, sans perdre vos modifications. Voir Mettre à jour depuis la source.
Et l’export ?
Section titled “Et l’export ?”Restorm génère des extraits de code pour chaque requête, dans tous les langages pertinents pour son protocole. Voir Export de code.