Bijwerken vanaf de bron

Een API-specificatie leeft. Opnieuw importeren en alles overschrijven zou uw aanpassingen laten verdwijnen; er naast opnieuw importeren zou een duplicaat opleveren. Restorm doet het derde: het berekent het verschil.

Hoe het werkt

Elke geslaagde import legt een vingerafdruk van de bron vast op de aangemaakte omgevingsmap. De knop Vernieuwen van de map haalt de bron op, vergelijkt de vingerafdrukken en past de verschillen toe in plaats van opnieuw te beginnen:

• de nieuwe operaties worden toegevoegd, op de plek waar een verse import ze zou hebben gezet;
• bij de gewijzigde operaties worden de parameters aangevuld met wat de specificatie toevoegt;
• de operaties die de specificatie als verouderd markeert worden gemarkeerd en verschijnen gedempt in de boom;
• de operaties die uit de bron zijn verdwenen worden als verwijderd gemarkeerd en verschijnen doorgestreept — ze blijven uitvoerbaar en worden nooit verwijderd;
• uw wijzigingen blijven behouden: naam, methode, URL en ingevoerde waarden worden nooit overschreven.

Het principe: de specificatie heeft gezag over wat zij beschrijft, u hebt gezag over de rest.

Het volledige verloop — waar de knop staat, wat de wizard laat zien voordat u toepast, wat er met de documentatie gebeurt — staat in Toegang tot en bijwerken van de documentatie van een geïmporteerde API.

Uitsluitend voor imports via een URL

De hersynchronisatie veronderstelt dat Restorm de bron kent. Alleen imports die vanaf een URL zijn gedaan, leggen er een vast; een import vanuit een bestand of via plakken is niet opnieuw te synchroniseren, ook al staat het formaat in de lijst hieronder.

Formaten die opnieuw te synchroniseren zijn

Het gaat om twaalf formaten:

• OpenAPI 3.x
• Swagger 2.0 (dezelfde pagina als de vorige, maar hier apart geteld: beide hebben hun eigen logica voor hersynchronisatie)
• GraphQL (SDL)
• gRPC — .proto-bestand en serverreflection
• SOAP / WSDL
• OData
• AsyncAPI
• Postman
• Insomnia
• Bruno
• OpenRPC
• Smithy

Formaten die niet opnieuw te synchroniseren zijn

HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.

Voor die formaten maakt een nieuwe import een nieuwe boom: u brengt de twee zelf bij elkaar, of u importeert in een aparte map.

Bijzonder geval: gRPC via reflection

Een gRPC-verzoek dat via reflection is geïmporteerd, heeft direct op zijn tabblad een knop Vernieuwen via reflection: dat is de kortste weg wanneer een service tijdens de ontwikkeling verandert.