Ažuriranje iz izvora

API specifikacija živi. Ponovni uvoz uz prebrisavanje svega izgubio bi vaša doterivanja; ponovni uvoz sa strane proizveo bi duplikat. Restorm radi treću stvar: računa deltu.

Kako to funkcioniše

Svaki uspešan uvoz beleži otisak izvora na napravljenoj fascikli promenljivih. Dugme Osveži na fascikli preuzima izvor, poredi otiske i primenjuje razlike umesto da kreće od nule:

• nove operacije se dodaju, na mesto na koje bi ih smestio svež uvoz;
• izmenjenim operacijama parametri se dopunjuju onim što specifikacija dodaje;
• operacije koje specifikacija označi kao zastarele se signaliziraju i u stablu se prikazuju izbledele;
• operacije nestale iz izvora signaliziraju se kao uklonjene i prikazuju se precrtane — ostaju izvršne i nikada se ne brišu;
• vaše izmene se čuvaju: naziv, metoda, URL i unete vrednosti nikada se ne prebrisuju.

Načelo: specifikacija ima vlast nad onim što opisuje, a vi imate vlast nad ostatkom.

Kompletan tok — gde se nalazi dugme, šta pokazuje čarobnjak pre primene, šta se dešava sa dokumentacijom — opisan je u Pristup dokumentaciji uvezenog API-ja i njeno ažuriranje.

Samo za uvoze sa URL-a

Ponovna sinhronizacija pretpostavlja da Restorm poznaje izvor. Samo uvozi napravljeni sa URL-a beleže izvor; uvoz iz datoteke ili lepljenjem ne može se ponovo sinhronizovati, čak i ako se njegov format nalazi na listi ispod.

Formati pogodni za ponovnu sinhronizaciju

Reč je o dvanaest formata:

• OpenAPI 3.x
• Swagger 2.0 (ista stranica kao prethodni, ali se ovde broji zasebno: svaki ima svoju logiku ponovne sinhronizacije)
• GraphQL (SDL)
• gRPC — .proto datoteka i serverska refleksija
• SOAP / WSDL
• OData
• AsyncAPI
• Postman
• Insomnia
• Bruno
• OpenRPC
• Smithy

Formati koji se ne mogu ponovo sinhronizovati

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

Za njih novi uvoz pravi novo stablo: na vama je da spojite ta dva ili da uvezete u namensku fasciklu.

Poseban slučaj: gRPC preko refleksije

gRPC zahtev uvezen refleksijom nosi dugme Osveži iz refleksije direktno na svojoj kartici: to je najkraći put kada se servis menja tokom razvoja.