1. Čo je Swagger UI?
Swagger je nástroj pre automatizované generovanie API dokumentácie z OpenApi špecifikácie. Prehľadne zobrazuje dostupné API metody a štruktúru údajov. Umožňuje rovno interakciu s API, vrátane zadania podporovaných autentizačných údajov.
2. Zadanie autentizačného údaju
Aby bylo možné požiadavky odosielať na API, je potrebné najskôr zadať autentizačné údaje.
Nad zoznamom API metód sa po kliknutí na tlačidlo Authorize zobrazí dialógové okno, v ktorom v závislosti na používanom type autorizácie v časti ApiKeyAuth zapíšte API kľúč, alebo v časti Oauth2 zadajte Client Id a Client Secret a zapnite voľbu Scope. Spôsob získania autentizačných údajov je popísaný v kapitole Spôsoby autentizácie na stránke Všeobecné.
Následne nastavenie potvrďte kliknutím na tlačidlo Authorize a dialógové okno zavrite prostredníctvom tlačidla Close.
3. Odoslanie požiadavky na API
Vyhľadajte požadovanú metodu, rozbaľte jej detail a následne kliknite na tlačidlo Try it out.
V závislosti na API metóde vyplňte požadované údaje a požiadavku odošlite na API príkazom Execute.
V prípade POST metody je potrebné pred odoslaním požiadavky po kliknutí na tlačidlo Try it out v časti Request body zadať v tele požiadavky údaje, potrebné pre vygenerovanie výsledného záznamu.
4. Odpoveď z API
V časti Responses/Server response sa po vykonaní požiadavky zobrazí výsledná odpoveď:
vygenerované údaje - úspešná operácia
Error - neúspešná operácia; v sekcii Response body je uvedený dôvod
