Tovább a tartalomhoz
Restorm Restorm dokumentáció

Frissítés a forrásból

Egy API-specifikáció folyamatosan él. A mindent felülíró újraimportálás elvesztené a kézi ráigazításokat; a mellé történő importálás duplikátumot hozna létre. A Restorm a harmadik utat választja: kiszámítja a különbséget.

A működés

Section titled “A működés”

Minden sikeres importálás ujjlenyomatot ment a forrásról a létrejövő környezeti mappára. A mappa Frissítés gombja letölti a forrást, összehasonlítja az ujjlenyomatokat, és a nulláról való újrakezdés helyett a különbségeket alkalmazza:

  • az új műveletek bekerülnek arra a helyre, ahová egy új importálás is helyezte volna őket;
  • a módosult műveletek paraméterei kiegészülnek azzal, amit a specifikáció hozzáad;
  • a specifikáció által elavultnak jelölt műveletek megjelölést kapnak, és elhalványítva jelennek meg a fában;
  • a forrásból eltűnt műveletek visszavontként vannak megjelölve, és áthúzva jelennek meg — futtathatók maradnak, és soha nem törlődnek;
  • a saját módosítások megmaradnak: a név, a metódus, az URL és a beírt értékek soha nem íródnak felül.

Az alapelv: a specifikáció mérvadó abban, amit leír, minden másban a felhasználó a mérvadó.

A teljes menet — hol található a gomb, mit mutat a varázsló az alkalmazás előtt, mi történik a dokumentációval — itt olvasható: Importált API dokumentációjának elérése és frissítése.

A fa egy frissítés után: az utolsó művelet, amely a specifikáció új változatából kimaradt, elhalványítva és áthúzva látszik — a projektben megmarad, soha nem törlődik

Újraszinkronizálható formátumok

Section titled “Újraszinkronizálható formátumok”

Tizenkét formátumról van szó:

Nem újraszinkronizálható formátumok

Section titled “Nem újraszinkronizálható formátumok”

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

Ezeknél egy újabb importálás új fát hoz létre: a kettő összevezetése kézi feladat, vagy érdemes külön mappába importálni.

Különleges eset: gRPC-reflexió útján

Section titled “Különleges eset: gRPC-reflexió útján”

A reflexió útján importált gRPC-kérésen közvetlenül a saját lapján található egy Frissítés reflectionből gomb: ez a legrövidebb út, amikor egy szolgáltatás fejlesztés közben változik.