Aktualizacja ze źródła

Specyfikacja API żyje. Ponowny import z nadpisaniem wszystkiego oznaczałby utratę wprowadzonych poprawek; import obok wytworzyłby duplikat. Restorm robi trzecią rzecz: oblicza deltę.

Jak to działa

Każdy udany import zapisuje odcisk źródła w utworzonym folderze zmiennych. Przycisk Odśwież w folderze pobiera źródło, porównuje odciski i stosuje różnice, zamiast zaczynać od zera:

• nowe operacje są dodawane, w tym miejscu, gdzie umieściłby je świeży import;
• zmienione operacje otrzymują parametry uzupełnione o to, co dodaje specyfikacja;
• operacje, które specyfikacja oznacza jako przestarzałe, są sygnalizowane i widnieją w drzewie jako przygaszone;
• operacje zniknięte ze źródła są sygnalizowane jako usunięte i widnieją jako przekreślone — pozostają wykonywalne i nigdy nie są usuwane;
• wprowadzone modyfikacje są zachowywane: nazwa, metoda, adres URL i wpisane wartości nigdy nie są nadpisywane.

Zasada: specyfikacja rozstrzyga o tym, co opisuje, użytkownik rozstrzyga o całej reszcie.

Pełny przebieg — gdzie znajduje się przycisk, co pokazuje kreator przed zastosowaniem zmian, co dzieje się z dokumentacją — jest opisany na stronie Dostęp do dokumentacji zaimportowanego API i jej aktualizacja.

Tylko dla importów przez adres URL

Ponowna synchronizacja zakłada, że Restorm zna źródło. Tylko importy wykonane z adresu URL je zapisują; importu z pliku lub przez wklejenie nie da się ponownie zsynchronizować, nawet jeśli jego format znajduje się na liście poniżej.

Formaty z ponowną synchronizacją

Dotyczy to dwunastu formatów:

• OpenAPI 3.x
• Swagger 2.0 (ta sama strona co poprzednio, ale liczony tu osobno: każdy z nich ma własną logikę ponownej synchronizacji)
• GraphQL (SDL)
• gRPC — plik .proto oraz refleksja serwera
• SOAP / WSDL
• OData
• AsyncAPI
• Postman
• Insomnia
• Bruno
• OpenRPC
• Smithy

Formaty bez ponownej synchronizacji

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

W ich przypadku nowy import tworzy nowe drzewo: pozostaje samodzielnie pogodzić oba albo zaimportować do dedykowanego folderu.

Przypadek szczególny: gRPC przez refleksję

Żądanie gRPC zaimportowane przez refleksję ma przycisk Odśwież z refleksji bezpośrednio na swojej zakładce: to najkrótsza droga, gdy usługa zmienia się w toku prac programistycznych.