LabCollector  nudi različite mogućnosti postavljanja. Spreman je za upotrebu (u mjeri u kojoj je to moguće), njegovom se konfiguracijom može lako upravljati Super-admin kako bi zadovoljili vaše specifične laboratorijske zahtjeve. U sklopu ovoga, LabCollector osigurava Swagger korisničko sučelje koji vam omogućuje istraživanje i testiranje REST API.

Šepurenje je web-bazirano sučelje koje pruža jednostavan način interakcije s API-jem. Korisnicima omogućuje pregled dostupnih API krajnjih točaka, njihovih parametara i odgovora koje vraćaju. Korisnici također mogu slati zahtjeve API-ju i pregledavati odgovore stvarnom vremenu.

U sljedećoj bazi znanja provest ćemo vas kroz način korištenja LabCollectorSwaggera, također ćemo pokriti kako pristupiti korisničkom sučelju Swagger, kako istražiti i testirati dostupne krajnje točke API-ja i kako automatski generirati dokumentaciju na temelju OpenAPI specifikacije.

1. Kako mogu pristupiti LabCollectorje Swagger?

2. Kako testirati API krajnje točke?

1. Kako mogu pristupiti LabCollectorje Swagger?

Da biste konfigurirali API svoje web usluge, jednostavno idite na ADMINISTRATOR -> DRUGO -> POSTAVKE -> API za web usluge:

• Novi raspon aplikacija temeljen na vašem LabCollector instanca se može implementirati i razvijati.
• Korištenje LabCollector kao pozadinska baza podataka, laboratorij može pružiti informacije na daljinu u vanjskim katalozima, biološkim resursima itd.
  
• LabCollector nudi vam API usluge koje vam mogu pomoći da se povežete s aplikacijom treće strane LabCollector.

           * Za više informacija pogledajte ovo KB.

Swaggeru se lako može pristupiti klikom na narančastu ikonu koji se nalazi desno od aplikacije koju želite integrirati (kao što je prikazano na slici ispod).

Nakon što kliknete na odgovarajuću ikonu Swagger, pojavit će se novi skočni prozor s porukom "Generiranje razmetanja moglo bi potrajati nekoliko sekundi“. Budući da generiranje OpenAPI specifikacije može potrajati neko vrijeme ovisno o složenosti samog API-ja. Kada ste spremni, jednostavno kliknite na "Stvorite Swagger za ovu aplikaciju” za pristup korisničkom sučelju Swagger.

Ako ste prethodno izradili Swagger za aplikaciju, klikom na ikonu Swagger otvorit će se skočni prozor koji vam daje opciju da prikažete trenutni Swagger ili ga osvježite kako biste generirali novi. Ovo je osobito korisno ako su napravljene promjene u API-ju od zadnjeg generiranja Swaggera.

Skočni prozor također prikazuje zadnji put kada je Swagger ažuriran, što vam pomaže da pratite valjanost Swaggera i može biti posebno korisno za velike API-je koji se često ažuriraju.

Na primjer, pretpostavimo da ste unijeli neke promjene u svoj LabCollector API krajnje točke, kao što je dodavanje ili modificiranje parametara, a želite osigurati da Swagger točno odražava te promjene. U tom slučaju možete jednostavno osvježiti Swagger klikom na gumb za osvježavanje, a novi Swagger će se generirati s ažuriranim informacijama.

1. Kako testirati API krajnje točke?

Nakon što ste izradili Swagger za odabranu aplikaciju, bit ćete automatski preusmjereni na Swagger UI sučelje, koje prikazuje popis dostupnih API krajnjih točaka na lijevoj strani zaslona (kao što je prikazano na snimci zaslona u nastavku). Ovo korisničko sučelje omogućuje vam jednostavno istraživanje mogućnosti API-ja, njegovo testiranje i generiranje dokumentacije na temelju OpenAPI specifikacije.

Zatim kliknite krajnju točku da biste vidjeli njezine detalje, uključujući parametre i odgovore koje vraća. U našem primjeru možemo vidjeti sve module i njihove odgovarajuće krajnje točke, uz kratak opis njihove radnje. Na primjer, to možemo vidjeti GET/napregnuti radi na dobivanju zapisa iz modula Strains & Cells, POST/naprezanja radi na dodavanju zapisa u isti modul… itd.

Da biste testirali krajnju točku, kliknite "Isprobaj” i unesite potrebne parametre (kao što je prikazano na slici ispod). To je osobito korisno pri razvoju i testiranju novih krajnjih točaka prije njihove integracije u vašu aplikaciju.

Na kraju, nakon što ste unijeli sve svoje parametre, kliknite na "Izvršiti” za slanje zahtjeva API-ju i pregled odgovora.

Tada možete vidjeti rezultat svog zahtjeva, zajedno sa svim lošim / neovlaštenim / zabranjenim zahtjevima ako ih je bilo.

Nadalje, korisničko sučelje Swagger omogućuje automatsko generiranje dokumentacije na temelju OpenAPI specifikacije. Ova se dokumentacija može preuzeti u različitim formatima, kao što su PDF ili JSON, i može se koristiti za priopćavanje mogućnosti API-ja drugim programerima.