Oppdatere fra kilden
En API-spesifikasjon lever. Å importere på nytt og overskrive alt ville gjøre at du mistet justeringene dine; å importere ved siden ville gi en dublett. Restorm gjør den tredje tingen: den regner ut deltaet.
Hvordan det virker
Section titled “Hvordan det virker”Hver import som lykkes, lagrer et fingeravtrykk av kilden på miljømappen som opprettes. Knappen Oppdater på mappen henter kilden, sammenligner fingeravtrykkene og bruker forskjellene istedenfor å starte på nytt fra bunnen:
- nye operasjoner legges til, der en helt ny import ville ha plassert dem;
- endrede operasjoner får parameterne sine utfylt med det spesifikasjonen legger til;
- operasjoner som spesifikasjonen merker som utdaterte markeres og vises nedtonet i treet;
- operasjoner som er forsvunnet fra kilden, markeres som fjernet og vises gjennomstreket — de er fortsatt kjørbare og slettes aldri;
- endringene dine beholdes: navn, metode, URL og verdier du har skrevet inn, blir aldri overskrevet.
Prinsippet: spesifikasjonen har siste ord om det den beskriver, du har siste ord om resten.
Hele forløpet — hvor knappen ligger, hva veiviseren viser før den bruker endringene, hva som skjer med dokumentasjonen — er beskrevet i Tilgang til og oppdatering av dokumentasjonen for et importert API.
Formater som kan synkroniseres på nytt
Section titled “Formater som kan synkroniseres på nytt”Tolv formater er omfattet:
- OpenAPI 3.x
- Swagger 2.0 (samme side som den forrige, men regnet for seg her: de to har hver sin logikk for resynkronisering)
- GraphQL (SDL)
- gRPC —
.proto-fil og server-reflection - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Formater som ikke kan synkroniseres på nytt
Section titled “Formater som ikke kan synkroniseres på nytt”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
For disse lager en ny import et nytt tre: det er opp til deg å samordne de to, eller å importere til en egen mappe.
Spesialtilfelle: gRPC via reflection
Section titled “Spesialtilfelle: gRPC via reflection”En gRPC-forespørsel som er importert via reflection, har en knapp Oppdater fra reflection rett på fanen sin: det er den korteste veien når en tjeneste endrer seg under utvikling.