LabCollector  ofron opsione të ndryshme konfigurimi. Është gati për përdorim (për aq sa është e mundur), konfigurimi i tij mund të menaxhohet lehtësisht nga Super-Admin për të përmbushur kërkesat tuaja specifike laboratorike. Si pjesë e kësaj, LabCollector siguron një Ndërfaqja e përdoruesit Swagger që ju mundëson të eksploroni dhe testoni REST API.

krekosje është një ndërfaqe e bazuar në ueb që ofron një mënyrë miqësore për përdoruesit për të bashkëvepruar me API-në. Ai i lejon përdoruesit të shikojnë pikat fundore të disponueshme të API, parametrat e tyre dhe përgjigjet që ata kthejnë. Përdoruesit gjithashtu mund të dërgojnë kërkesa në API dhe të shikojnë përgjigjet në në kohë reale.

Në bazën e njohurive në vijim, ne do t'ju tregojmë se si ta përdorni LabCollector's Swagger, ne do të mbulojmë gjithashtu se si të aksesoni Swagger UI, si të eksploroni dhe testoni pikat fundore të disponueshme të API dhe si të gjeneroni dokumentacion automatikisht bazuar në specifikimet OpenAPI.

1. Si mund të hyj LabCollectorSwagger?

2. Si të testoni pikat fundore të API?

1. Si mund të hyj LabCollectorSwagger?

Për të konfiguruar API-në e shërbimeve të internetit, thjesht shkoni te ADMIN -> TJERA -> SETUP -> API e Shërbimeve të Uebit:

• Një gamë e re aplikacionesh bazuar në tuajin LabCollector shembulli mund të zbatohet dhe zhvillohet.
• Përdorim LabCollector si një bazë të dhënash mbështetëse, laboratori mund të sigurojë informacion në distancë në katalogë të jashtëm, burime biologjike, etj.
  
• LabCollector ju ofron shërbime API që mund t'ju ndihmojnë të lidhni një aplikacion të palës së tretë LabCollector.

           * Për më shumë informacion, ju lutemi referojuni kësaj KB.

Swagger mund të arrihet lehtësisht duke klikuar në ikonën portokalli ndodhet në të djathtë të aplikacionit që dëshironi të integroni (siç tregohet në pamjen e ekranit më poshtë).

Pasi të keni klikuar në ikonën përkatëse Swagger, do të shfaqet një dritare e re që shfaq mesazhin "Gjenerimi i rrëqethjes mund të zgjasë disa sekonda“. Meqenëse gjenerimi i specifikimit OpenAPI mund të marrë pak kohë në varësi të kompleksitetit të vetë API-së. Pasi të jeni gati, thjesht klikoni në "Krijo Swagger për këtë aplikacion" për të hyrë në Swagger UI.

Nëse keni krijuar më parë një Swagger për një aplikacion, duke klikuar në ikonën Swagger do të hapet një dritare kërcyese që ju jep mundësinë ose të shfaqni Swagger-in aktual ose ta rifreskoni atë për të gjeneruar një të ri. Kjo është veçanërisht e dobishme nëse janë bërë ndryshime në API që nga hera e fundit që u krijua Swagger.

Drita kërcyese shfaq gjithashtu herën e fundit që është përditësuar Swagger, gjë që ju ndihmon të mbani gjurmët e vlefshmërisë së Swagger dhe mund të jetë veçanërisht e dobishme për API-të e mëdha që përditësohen shpesh.

Për shembull, supozoni se keni bërë disa ndryshime në tuaj LabCollector Pikat fundore të API, të tilla si shtimi ose modifikimi i parametrave, dhe ju dëshironi të siguroheni që Swagger i pasqyron me saktësi këto ndryshime. Në atë rast, thjesht mund të rifreskoni Swagger duke klikuar në butonin e rifreskimit dhe do të krijohet një Swagger i ri me informacionin e përditësuar.

1. Si të testoni pikat fundore të API?

Pasi të keni krijuar një Swagger për aplikacionin tuaj të zgjedhur, do të ridrejtoheni automatikisht në ndërfaqen Swagger UI, e cila shfaq një listë të pikave fundore të disponueshme të API në anën e majtë të ekranit (siç tregohet në pamjen e ekranit më poshtë). Kjo ndërfaqe miqësore për përdoruesit ju lejon të eksploroni me lehtësi aftësitë e API-së, ta provoni atë dhe të gjeneroni dokumentacion bazuar në specifikimet e OpenAPI.

Pastaj, klikoni në një pikë fundore për të parë detajet e saj, duke përfshirë parametrat e saj dhe përgjigjet që kthen. Në shembullin tonë, ne mund të shohim të gjitha modulet dhe pikat fundore të tyre përkatëse, së bashku me një përshkrim të shkurtër të veprimit të tyre. Për shembull, ne mund ta shohim atë GET / sforcimet punon në marrjen e të dhënave nga moduli Strains & Cells, POST/sforcimet punon në shtimin e regjistrimeve në të njëjtin modul… etj.

Për të testuar një pikë fundore, klikoni "Provojebutonin ” dhe futni parametrat e kërkuar (siç tregohet në pamjen e ekranit më poshtë). Kjo është veçanërisht e dobishme kur zhvilloni dhe testoni pika të reja fundore përpara se t'i integroni ato në aplikacionin tuaj.

Së fundi, pasi të keni futur të gjithë parametrat tuaj, klikoni në "zbatojbutoni për të dërguar kërkesën në API dhe për të parë përgjigjen.

Më pas mund të shihni rezultatin e kërkesës suaj, së bashku me të gjitha kërkesat e këqija / të paautorizuara / të ndaluara nëse ka pasur.

Për më tepër, Swagger UI ju lejon të gjeneroni dokumentacion automatikisht bazuar në specifikimet OpenAPI. Ky dokumentacion mund të shkarkohet në formate të ndryshme, si PDF ose JSON, dhe mund të përdoret për të komunikuar aftësitë e API me zhvilluesit e tjerë.