Přeskočit na obsah
Restorm Dokumentace Restorm

Aktualizace ze zdroje

Specifikace API se vyvíjí. Přeimportovat ji tak, že vše přepíšete, by znamenalo přijít o vaše úpravy; naimportovat ji vedle by vytvořilo duplikát. Restorm dělá třetí věc: spočítá rozdíl.

Jak to funguje

Section titled “Jak to funguje”

Každý úspěšný import uloží na vytvořenou složku proměnných otisk zdroje. Tlačítko Aktualizovat na složce zdroj znovu načte, porovná otisky a použije rozdíly, místo aby začínal od nuly:

  • nové operace se přidají tam, kam by je umístil nový import;
  • u změněných operací se parametry doplní o to, co specifikace přidává;
  • operace, které specifikace označuje jako zavržené, jsou označeny a ve stromu se zobrazují zesvětlené;
  • operace, které ze zdroje zmizely, jsou označeny jako odebrané a zobrazují se přeškrtnuté — zůstávají spustitelné a nikdy se nesmažou;
  • vaše úpravy zůstávají zachovány: název, metoda, URL ani zadané hodnoty se nikdy nepřepíšou.

Princip je tento: specifikace má autoritu nad tím, co popisuje, vy máte autoritu nad ostatním.

Celý postup — kde tlačítko najdete, co průvodce zobrazí, než změny použije, a co se stane s dokumentací — je popsán na stránce Přístup k dokumentaci importovaného API a její aktualizace.

Strom po aktualizaci: poslední operace, která v nové verzi specifikace chybí, je zesvětlená a přeškrtnutá — v projektu zůstává, nikdy se nesmaže

Formáty, které lze znovu synchronizovat

Section titled “Formáty, které lze znovu synchronizovat”

Týká se to dvanácti formátů:

Formáty, které znovu synchronizovat nelze

Section titled “Formáty, které znovu synchronizovat nelze”

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

U nich vytvoří nový import nový strom: je na vás oba sladit, nebo importovat do vyhrazené složky.

Zvláštní případ: gRPC přes reflexi

Section titled “Zvláštní případ: gRPC přes reflexi”

Požadavek gRPC naimportovaný přes reflexi má tlačítko Obnovit z reflection přímo na své kartě: to je nejkratší cesta, když se služba během vývoje mění.