Mettre à jour depuis la source
Une spécification d’API vit. Réimporter en écrasant tout ferait perdre vos ajustements ; réimporter à côté produirait un doublon. Restorm fait la troisième chose : il calcule le delta.
Comment ça marche
Section titled “Comment ça marche”Chaque import réussi enregistre une empreinte de la source sur le dossier de variables créé. Le bouton Actualiser du dossier récupère la source, compare les empreintes et applique les différences plutôt que de repartir de zéro :
- les nouvelles opérations sont ajoutées, à l’endroit où un import neuf les aurait placées ;
- les opérations modifiées voient leurs paramètres complétés par ce que la spécification ajoute ;
- les opérations que la spécification marque dépréciées sont signalées et apparaissent estompées dans l’arbre ;
- les opérations disparues de la source sont signalées comme retirées et apparaissent barrées — elles restent exécutables et ne sont jamais supprimées ;
- vos modifications sont conservées : nom, méthode, URL et valeurs saisies ne sont jamais écrasés.
Le principe : la spécification a autorité sur ce qu’elle décrit, vous avez autorité sur le reste.
Le déroulé complet — où se trouve le bouton, ce que montre l’assistant avant d’appliquer, ce qui arrive à la documentation — est décrit dans Accès et mise à jour de la documentation d’une API importée.
Formats re-synchronisables
Section titled “Formats re-synchronisables”Douze formats sont concernés :
- OpenAPI 3.x
- Swagger 2.0 (même page que le précédent, mais compté à part ici : les deux ont leur propre logique de re-synchronisation)
- GraphQL (SDL)
- gRPC — fichier
.protoet réflexion serveur - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Formats non re-synchronisables
Section titled “Formats non re-synchronisables”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
Pour ceux-là, un nouvel import crée un nouvel arbre : à vous de rapprocher les deux, ou d’importer dans un dossier dédié.
Cas particulier : gRPC par réflexion
Section titled “Cas particulier : gRPC par réflexion”Une requête gRPC importée par réflexion porte un bouton Rafraîchir depuis la réflexion directement sur son onglet : c’est le chemin le plus court quand un service évolue en cours de développement.