LabCollector  ponuja različne možnosti nastavitve. Pripravljen je za uporabo (kolikor je to mogoče), je njegovo konfiguracijo enostavno upravljati z Super-skrbnik da bi izpolnili vaše specifične laboratorijske zahteve. V okviru tega je LabCollector določa Swagger uporabniški vmesnik ki vam omogoča raziskovanje in testiranje REST API.

premetavanje je spletni vmesnik, ki omogoča uporabniku prijazen način interakcije z API-jem. Uporabnikom omogoča ogled razpoložljivih končnih točk API-ja, njihovih parametrov in odgovorov, ki jih vrnejo. Uporabniki lahko tudi pošljejo zahteve API-ju in si ogledajo odgovore v v realnem času.

V naslednji zbirki znanja vas bomo vodili skozi uporabo LabCollectorSwagger, bomo obravnavali tudi, kako dostopati do uporabniškega vmesnika Swagger, kako raziskati in preizkusiti razpoložljive končne točke API-ja in kako samodejno ustvariti dokumentacijo na podlagi specifikacije OpenAPI.

1. Kako lahko dostopam LabCollectorje Swagger?

2. Kako preizkusiti končne točke API-ja?

1. Kako lahko dostopam LabCollectorje Swagger?

Če želite konfigurirati API za spletne storitve, preprosto pojdite na SKRBNIK -> DRUGO -> NASTAVITEV -> API spletnih storitev:

• Nov nabor aplikacij, ki temeljijo na vašem LabCollector primerek je mogoče implementirati in razvijati.
• Uporaba LabCollector kot zaledna podatkovna zbirka lahko laboratorij zagotovi informacije na daljavo v zunanjih katalogih, bioloških virih itd.
  
• LabCollector ponuja storitve API, ki vam lahko pomagajo pri povezovanju aplikacije tretjih oseb LabCollector.

           * Za več informacij si oglejte to KB.

Swagger lahko enostavno dostopate s klikom na oranžno ikono ki se nahaja na desni strani aplikacije, ki jo želite integrirati (kot je prikazano na spodnjem posnetku zaslona).

Ko kliknete ustrezno ikono Swagger, se prikaže novo pojavno okno s sporočilom »Ustvarjanje bahanja lahko traja nekaj sekund“. Ker lahko generiranje specifikacije OpenAPI traja nekaj časa, odvisno od kompleksnosti samega API-ja. Ko ste pripravljeni, preprosto kliknite »Ustvarite Swagger za to aplikacijo” za dostop do uporabniškega vmesnika Swagger.

Če ste že ustvarili Swagger za aplikacijo, boste s klikom na ikono Swagger odprli pojavno okno, ki vam daje možnost, da prikažete trenutni Swagger ali ga osvežite, da ustvarite novega. To je še posebej uporabno, če je bil API spremenjen od zadnjega ustvarjanja Swaggerja.

Pojavno okno prikazuje tudi čas zadnje posodobitve Swaggerja, kar vam pomaga spremljati veljavnost Swaggerja in je lahko še posebej uporabno za velike API-je, ki se pogosto posodabljajo.

Recimo, da ste naredili nekaj sprememb v svojem LabCollector Končne točke API-ja, kot je dodajanje ali spreminjanje parametrov, in želite zagotoviti, da Swagger natančno odraža te spremembe. V tem primeru lahko preprosto osvežite Swagger s klikom na gumb za osvežitev in ustvarjen bo nov Swagger s posodobljenimi informacijami.

1. Kako preizkusiti končne točke API-ja?

Ko ustvarite Swagger za izbrano aplikacijo, boste samodejno preusmerjeni na vmesnik uporabniškega vmesnika Swagger, ki na levi strani zaslona prikaže seznam razpoložljivih končnih točk API (kot je prikazano na spodnjem posnetku zaslona). Ta uporabniku prijazen vmesnik vam omogoča preprosto raziskovanje zmožnosti API-ja, njegovo testiranje in ustvarjanje dokumentacije na podlagi specifikacije OpenAPI.

Nato kliknite končno točko, da si ogledate njene podrobnosti, vključno z njenimi parametri in odzivi, ki jih vrne. V našem primeru lahko vidimo vse module in njihove ustrezne končne točke, skupaj s kratkim opisom njihovega delovanja. Na primer, to lahko vidimo GET/sevi dela na pridobivanju zapisov iz modula Strains & Cells, POST/sevi dela na dodajanju zapisov v isti modul ... itd.

Če želite preizkusiti končno točko, kliknite »Poskusi” in vnesite zahtevane parametre (kot je prikazano na spodnjem posnetku zaslona). To je še posebej koristno pri razvoju in testiranju novih končnih točk, preden jih vključite v svojo aplikacijo.

Na koncu, ko vnesete vse svoje parametre, kliknite »Izvedba”, da pošljete zahtevo API-ju in si ogledate odgovor.

Nato si lahko ogledate rezultat svoje zahteve, poleg vseh slabih / nepooblaščenih / prepovedanih zahtev, če so bile.

Poleg tega uporabniški vmesnik Swagger omogoča samodejno ustvarjanje dokumentacije na podlagi specifikacije OpenAPI. To dokumentacijo je mogoče prenesti v različnih formatih, kot sta PDF ali JSON, in jo lahko uporabite za sporočanje zmogljivosti API-ja drugim razvijalcem.