Opdatér fra kilden
En API-specifikation lever. At importere igen og overskrive alt ville koste dig dine justeringer; at importere ved siden af ville give en dublet. Restorm gør det tredje: den beregner forskellen.
Sådan virker det
Section titled “Sådan virker det”Hver vellykket import gemmer et fingeraftryk af kilden på den miljømappe, der oprettes. Mappens Opdater-knap henter kilden, sammenligner fingeraftrykkene og anvender forskellene frem for at starte forfra:
- nye operationer tilføjes dér, hvor en helt ny import ville have lagt dem;
- ændrede operationer får deres parametre suppleret med dét, specifikationen tilføjer;
- de operationer, specifikationen markerer som forældede, markeres og vises nedtonet i træstrukturen;
- de operationer, der er forsvundet fra kilden, markeres som fjernede og vises overstreget — de kan stadig køres og slettes aldrig;
- dine ændringer bevares: navn, metode, URL og indtastede værdier overskrives aldrig.
Princippet: specifikationen bestemmer over det, den beskriver, og du bestemmer over resten.
Hele forløbet — hvor knappen er, hvad guiden viser, inden der anvendes noget, og hvad der sker med dokumentationen — er beskrevet i Adgang til og opdatering af dokumentationen for et importeret API.
Formater, der kan gensynkroniseres
Section titled “Formater, der kan gensynkroniseres”Tolv formater er omfattet:
- OpenAPI 3.x
- Swagger 2.0 (samme side som det foregående, men talt for sig her: de to har hver deres logik for gensynkronisering)
- GraphQL (SDL)
- gRPC —
.proto-fil og serverrefleksion - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Formater, der ikke kan gensynkroniseres
Section titled “Formater, der ikke kan gensynkroniseres”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
For dem gælder, at en ny import opretter en ny træstruktur: så er det op til dig at føre de to sammen eller at importere i en mappe for sig.
Særtilfælde: gRPC via refleksion
Section titled “Særtilfælde: gRPC via refleksion”En gRPC-anmodning, der er importeret via refleksion, har en knap, Opdater fra refleksionen, direkte på sin fane: det er den korteste vej, når en tjeneste ændrer sig undervejs i udviklingen.