LabCollector  siūlo įvairias nustatymo parinktis. Jis yra paruoštas naudoti (kiek įmanoma), jo konfigūraciją gali lengvai valdyti Super administratorius kad atitiktų jūsų specifinius laboratorijos reikalavimus. Kaip to dalis, LabCollector suteikia Swagger vartotojo sąsaja kuri leidžia tyrinėti ir išbandyti POILSIO API.

Swaggeris yra žiniatinklio sąsaja, kuri suteikia vartotojui patogų būdą sąveikauti su API. Tai leidžia vartotojams peržiūrėti galimus API galutinius taškus, jų parametrus ir grąžinamus atsakymus. Vartotojai taip pat gali siųsti užklausas į API ir peržiūrėti atsakymus realiu laiku.

Šioje žinių bazėje paaiškinsime, kaip naudotis LabCollectorSwagger, taip pat apžvelgsime, kaip pasiekti Swagger vartotojo sąsają, kaip ištirti ir išbandyti galimus API galutinius taškus ir kaip automatiškai generuoti dokumentus pagal OpenAPI specifikaciją.

1. Kaip galiu pasiekti LabCollectorAr Swaggeris?

2. Kaip išbandyti API galinius taškus?

1. Kaip galiu pasiekti LabCollectorAr Swaggeris?

Norėdami sukonfigūruoti žiniatinklio paslaugų API, tiesiog eikite į ADMINISTRATORIUS -> KITA -> NUSTATYMAS -> Web Services API:

• Naujas programų asortimentas, pagrįstas jūsų LabCollector pavyzdys gali būti įgyvendintas ir tobulinamas.
• Naudojant LabCollector kaip užpakalinė duomenų bazė, laboratorija gali teikti nuotolinę informaciją išoriniuose kataloguose, biologiniuose ištekliuose ir kt.
  
• LabCollector siūlo API paslaugas, kurios gali padėti prijungti trečiosios šalies programą LabCollector.

           * Daugiau informacijos rasite čia KB.

„Swagger“ galima lengvai pasiekti spustelėjus oranžinę piktogramą esančios programos, kurią norite integruoti, dešinėje (kaip parodyta toliau esančioje ekrano kopijoje).

Kai spustelėsite atitinkamą „Swagger“ piktogramą, pasirodys naujas iššokantis langas su pranešimu „Swagger generavimas gali užtrukti kelias sekundes“. Kadangi OpenAPI specifikacijos generavimas gali užtrukti, priklausomai nuo pačios API sudėtingumo. Kai būsite pasiruošę, tiesiog spustelėkite „Sukurkite „Swagger“ šiai programai“, kad pasiektumėte „Swagger“ vartotojo sąsają.

Jei anksčiau sukūrėte programos „Swagger“, spustelėję „Swagger“ piktogramą atsidarys iššokantis langas, kuriame galėsite rodyti esamą „Swagger“ arba atnaujinti jį, kad būtų sukurta nauja. Tai ypač naudinga, jei nuo paskutinio „Swagger“ sukūrimo buvo atlikti API pakeitimai.

Iššokančiajame lange taip pat rodomas paskutinis kartas, kai buvo atnaujintas „Swagger“, kuris padeda stebėti „Swagger“ galiojimą ir gali būti ypač naudingas didelėms API, kurios dažnai atnaujinamos.

Pavyzdžiui, tarkime, kad atlikote kai kuriuos savo pakeitimus LabCollector API galinius taškus, pvz., parametrų pridėjimą arba keitimą, ir norite užtikrinti, kad „Swagger“ tiksliai atspindėtų šiuos pakeitimus. Tokiu atveju galite tiesiog atnaujinti Swagger spustelėdami atnaujinimo mygtuką ir bus sukurtas naujas Swagger su atnaujinta informacija.

1. Kaip išbandyti API galinius taškus?

Sukūrę pasirinktai programai „Swagger“, būsite automatiškai nukreipti į „Swagger“ vartotojo sąsają, kurioje kairėje ekrano pusėje rodomas galimų API galinių taškų sąrašas (kaip parodyta toliau esančioje ekrano kopijoje). Ši patogi sąsaja leidžia lengvai ištirti API galimybes, ją išbandyti ir generuoti dokumentaciją pagal OpenAPI specifikaciją.

Tada spustelėkite galinį tašką, kad peržiūrėtumėte jo išsamią informaciją, įskaitant parametrus ir pateikiamus atsakymus. Mūsų pavyzdyje galime pamatyti visus modulius ir atitinkamus galutinius taškus kartu su trumpu jų veiksmų aprašymu. Pavyzdžiui, mes galime tai pamatyti GET / padermės dirba gaudamas įrašus iš modulio Padermės ir ląstelės, POST / padermės dirba pridedant įrašus į tą patį modulį... ir t.t.

Norėdami išbandyti galinį tašką, spustelėkite „Išbandyk“ mygtuką ir įveskite reikiamus parametrus (kaip parodyta toliau esančioje ekrano kopijoje). Tai ypač naudinga kuriant ir išbandant naujus galutinius taškus prieš integruojant juos į programą.

Galiausiai, įvedę visus parametrus, spustelėkite „Vykdyti“ mygtuką, norėdami išsiųsti užklausą API ir peržiūrėti atsakymą.

Tada galėsite matyti savo užklausos rezultatą kartu su visomis blogomis / neteisėtomis / draudžiamomis užklausomis, jei tokių buvo.

Be to, „Swagger“ vartotojo sąsaja leidžia automatiškai generuoti dokumentus pagal „OpenAPI“ specifikaciją. Šią dokumentaciją galima atsisiųsti įvairiais formatais, pvz., PDF arba JSON, ir gali būti naudojama kitiems kūrėjams pranešti apie API galimybes.