Ažuriranje iz izvora
Specifikacija API-ja živi. Ponovni uvoz uz brisanje svega izgubio bi vaša podešavanja; ponovni uvoz usporedo proizveo bi duplikat. Restorm radi treću stvar: računa razliku.
Kako to radi
Section titled “Kako to radi”Svaki uspješan uvoz bilježi otisak izvora na stvorenoj mapi okruženja. Gumb Osvježi u mapi dohvaća izvor, uspoređuje otiske i primjenjuje razlike umjesto da kreće ispočetka:
- nove operacije dodaju se na mjesto na koje bi ih smjestio svježi uvoz;
- izmijenjenim operacijama parametri se dopunjuju onime što specifikacija dodaje;
- operacije koje specifikacija označava zastarjelima označavaju se i u stablu se pojavljuju izblijedjelo;
- operacije nestale iz izvora označavaju se kao uklonjene i pojavljuju se precrtano — ostaju izvedive i nikada se ne brišu;
- vaše se izmjene čuvaju: naziv, metoda, URL i unesene vrijednosti nikada se ne prebrisuju.
Načelo: specifikacija je mjerodavna za ono što opisuje, vi ste mjerodavni za ostalo.
Cjelovit tijek — gdje se nalazi gumb, što čarobnjak pokazuje prije primjene, što se događa s dokumentacijom — opisan je u članku Pristup dokumentaciji uvezenog API-ja i njezino ažuriranje.
Formati koji se mogu ponovno sinkronizirati
Section titled “Formati koji se mogu ponovno sinkronizirati”Riječ je o dvanaest formata:
- OpenAPI 3.x
- Swagger 2.0 (ista stranica kao prethodni, ali se ovdje broji zasebno: oba imaju vlastitu logiku ponovne sinkronizacije)
- GraphQL (SDL)
- gRPC — datoteka
.protoi refleksija poslužitelja - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Formati koji se ne mogu ponovno sinkronizirati
Section titled “Formati koji se ne mogu ponovno sinkronizirati”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
Za njih novi uvoz stvara novo stablo: na vama je da to dvoje uskladite ili da uvezete u namjensku mapu.
Poseban slučaj: gRPC putem refleksije
Section titled “Poseban slučaj: gRPC putem refleksije”gRPC zahtjev uvezen refleksijom nosi gumb Osvježi iz refleksije izravno na svojoj kartici: to je najkraći put kada se usluga mijenja tijekom razvoja.