Odhalování problémů v importovaném API

Když importujete API (OpenAPI, Swagger a další podporované formáty), Restorm uchovává strukturovanou dokumentaci API v jeho složce proměnných. Hned po importu — a při každém opětovném otevření souboru — Restorm tuto dokumentaci nenápadně promítne do návrhu a spustí stejnou validaci, jakou používá Návrhář API, zcela na pozadí. Nikdy neblokuje import a nikdy nepřeruší to, co právě děláte.

Pokud nic nenajde, nic neuvidíte. Pokud najde strukturální problémy, upozorní vás na ně na dvou místech.

„!“ v postranním panelu

Složka proměnných, která nese označené API, zobrazuje vpravo ve svém řádku malý „!“. Je to signál na první pohled, že návrh tohoto API stojí za prohlédnutí — a zmizí sám, jakmile je API opět v pořádku (po opětovném importu nebo po aktualizaci API, která problém odstraní).

Karta „Problémy“

Otevřete složku proměnných a získá kartu „Problémy“. Karta se objeví, pouze pokud byly zjištěny problémy — u bezchybného API se nikdy nezobrazí.

Karta „Problémy“ složky proměnných importovaného API: výstražné upozornění, poté problémy seskupené podle typu — „Několik tras odpovídá na stejnou metodu a cestu“, „Některé trasy nedeklarují žádnou odpověď“, „Některé trasy leží na cestě, kterou si vyhrazuje návrhový server“ — každý s uvedením přesně dotčených tras, jedna rozbalená, aby ukázala dokumentaci dané trasy

Problémy jsou seskupeny podle typu, takže dvacet duplicitních tras se zobrazí jako jeden řádek s počtem místo dvaceti samostatných položek. Pod každým typem Restorm vypíše přesně dotčené entity — trasa zobrazuje své HTTP sloveso a skutečnou cestu a rozbalí se na dokumentaci dané trasy, takže vidíte, co deklaruje, aniž byste kartu opustili.

Kontroly odpovídají kontrolám Návrháře API, takže mezi problémy, na které můžete narazit, patří:

duplicitní trasy — dvě trasy, které odpovídají na stejnou metodu a cestu;
chybějící odpovědi — trasa, která nedeklaruje vůbec žádnou odpověď;
vyhrazené cesty — trasa, která leží na cestě, kterou si vyhrazuje Mock Server (/swagger.json, /graphql, …) a která by nikdy neodpověděla;
problémy s omezeními — neplatný vzor nebo minimum vyšší než jeho maximum.

Seznam je pouze pro čtení: říká vám, co opravit, a vy to opravíte u zdroje (znovu importujte opravenou specifikaci nebo upravte API). Přepočítává se při událostech, které API mění — otevření souboru, import, aktualizace API — nikoli při každém stisku klávesy.