Uppdatera från källan
En API-specifikation lever. Att importera om och skriva över allt skulle göra att dina justeringar går förlorade; att importera om vid sidan skulle ge en dubblett. Restorm gör det tredje: beräknar deltat.
Så fungerar det
Section titled “Så fungerar det”Varje lyckad import sparar ett fingeravtryck av källan på den variabelmapp som skapas. Mappens knapp Uppdatera hämtar källan, jämför fingeravtrycken och tillämpar skillnaderna i stället för att börja om från noll:
- de nya operationerna läggs till, där en ny import skulle ha placerat dem;
- de ändrade operationerna får sina parametrar kompletterade med det som specifikationen lägger till;
- de operationer som specifikationen märker som utfasade markeras och visas nedtonade i trädet;
- de operationer som försvunnit ur källan markeras som borttagna och visas överstrukna — de går fortfarande att köra och tas aldrig bort;
- dina ändringar behålls: namn, metod, URL och inmatade värden skrivs aldrig över.
Principen: specifikationen bestämmer över det den beskriver, du bestämmer över resten.
Hela förloppet — var knappen finns, vad guiden visar innan den tillämpar något, vad som händer med dokumentationen — beskrivs i Läsa och uppdatera dokumentationen för ett importerat API.
Format som går att synkronisera om
Section titled “Format som går att synkronisera om”Tolv format berörs:
- OpenAPI 3.x
- Swagger 2.0 (samma sida som föregående, men räknas separat här: de två har var sin egen logik för omsynkronisering)
- GraphQL (SDL)
- gRPC —
.proto-fil och serverreflektion - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Format som inte går att synkronisera om
Section titled “Format som inte går att synkronisera om”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
För dem skapar en ny import ett nytt träd: du får själv jämka samman de två, eller importera till en egen mapp.
Specialfall: gRPC via reflektion
Section titled “Specialfall: gRPC via reflektion”En gRPC-begäran som importerats via reflektion har en knapp Uppdatera från reflektionen direkt på sin flik: det är den kortaste vägen när en tjänst förändras under utvecklingen.