LabCollector  առաջարկում է տեղադրման տարբեր տարբերակներ: Այն պատրաստ է օգտագործման (որքան հնարավոր է), դրա կոնֆիգուրացիան կարող է հեշտությամբ կառավարվել Սուպեր-ադմին ձեր հատուկ լաբորատոր պահանջները բավարարելու համար: Որպես դրա մի մաս, LabCollector ապահովում է Swagger UI որը հնարավորություն է տալիս ուսումնասիրել և փորձարկել REST API.

Swagger- ը վեբ վրա հիմնված ինտերֆեյս է, որն ապահովում է API-ի հետ փոխգործակցության հարմար եղանակ: Այն թույլ է տալիս օգտվողներին դիտել հասանելի API-ի վերջնակետերը, դրանց պարամետրերը և պատասխանները, որոնք նրանք տալիս են: Օգտագործողները կարող են նաև հարցումներ ուղարկել API և դիտել պատասխանները իրական ժամանակում.

Հետևյալ Գիտելիքի բազայում մենք ձեզ կսովորեցնենք, թե ինչպես օգտագործել այն LabCollectorSwagger-ում, մենք նաև կանդրադառնանք, թե ինչպես մուտք գործել Swagger UI, ինչպես ուսումնասիրել և փորձարկել հասանելի API-ի վերջնակետերը և ինչպես ստեղծել փաստաթղթեր ավտոմատ կերպով՝ հիմնվելով OpenAPI-ի ճշգրտման վրա:

1. Ինչպես կարող եմ մուտք գործել LabCollectorՍվագե՞րն է:

2. Ինչպե՞ս ստուգել API-ի վերջնակետերը:

1. Ինչպես կարող եմ մուտք գործել LabCollectorՍվագե՞րն է:

Ձեր վեբ ծառայությունների API-ն կարգավորելու համար պարզապես գնացեք ADMIN -> ԱՅԼ -> SETUP -> Վեբ ծառայությունների API:

• Ձեր հիման վրա հիմնված հավելվածների նոր շարք LabCollector օրինակը կարող է իրականացվել և մշակվել:
• Օգտագործելով LabCollector որպես backend տվյալների բազա, լաբորատորիան կարող է տրամադրել հեռավոր տեղեկատվություն արտաքին կատալոգներում, կենսաբանական ռեսուրսներում և այլն:
  
• LabCollector առաջարկում է ձեզ API ծառայություններ, որոնք կարող են օգնել ձեզ միացնել երրորդ կողմի հավելվածը LabCollector.

           * Լրացուցիչ տեղեկությունների համար, խնդրում ենք դիմել այս KB.

Swagger-ին կարելի է հեշտությամբ մուտք գործել՝ սեղմելով նարնջագույն պատկերակի վրա գտնվում է այն հավելվածի աջ կողմում, որը ցանկանում եք ինտեգրել (ինչպես ցույց է տրված ստորև ներկայացված սքրինշոթում):

Հենց որ սեղմեք համապատասխան Swagger պատկերակի վրա, նոր թռուցիկ կհայտնվի՝ ցուցադրելով հաղորդագրությունը «Կեղծիքի ստեղծումը կարող է տևել մի քանի վայրկյան«. Քանի որ OpenAPI-ի ճշգրտման ստեղծումը կարող է որոշ ժամանակ տևել՝ կախված հենց API-ի բարդությունից: Երբ պատրաստ եք, պարզապես սեղմեք «Ստեղծեք Swagger այս հավելվածի համար« Swagger UI մուտք գործելու համար:

Եթե ​​նախկինում ստեղծել եք Swagger հավելվածի համար, սեղմելով Swagger պատկերակը կբացվի թռուցիկ, որը հնարավորություն է տալիս կամ ցուցադրել ընթացիկ Swagger-ը կամ թարմացնել այն՝ նորը ստեղծելու համար: Սա հատկապես օգտակար է, եթե API-ում փոփոխություններ են կատարվել վերջին անգամ Swagger-ի ստեղծման պահից:

Բացվող պատուհանը նաև ցույց է տալիս Swagger-ի վերջին թարմացումը, որն օգնում է ձեզ հետևել Swagger-ի վավերականությանը և կարող է հատկապես օգտակար լինել մեծ API-ների համար, որոնք հաճախ թարմացվում են:

Օրինակ, ենթադրենք, որ դուք որոշակի փոփոխություններ եք կատարել ձեր մեջ LabCollector API-ի վերջնակետերը, ինչպիսիք են պարամետրերի ավելացումը կամ փոփոխումը, և դուք ցանկանում եք համոզվել, որ Swagger-ը ճշգրիտ արտացոլում է այս փոփոխությունները: Այդ դեպքում դուք կարող եք պարզապես թարմացնել Swagger-ը՝ սեղմելով թարմացման կոճակը, և թարմացված տեղեկություններով կստեղծվի նոր Swagger։

1. Ինչպե՞ս ստուգել API-ի վերջնակետերը:

Երբ դուք ստեղծեք Swagger ձեր ընտրած հավելվածի համար, դուք ավտոմատ կերպով կուղղորդվեք դեպի Swagger UI ինտերֆեյս, որը ցուցադրում է հասանելի API-ի վերջնակետերի ցանկը էկրանի ձախ կողմում (ինչպես ցույց է տրված ստորև նշված սքրինշոթում): Օգտագործողի համար հարմար այս ինտերֆեյսը թույլ է տալիս հեշտությամբ ուսումնասիրել API-ի հնարավորությունները, փորձարկել այն և ստեղծել փաստաթղթեր՝ հիմնված OpenAPI-ի առանձնահատկությունների վրա:

Այնուհետև կտտացրեք վերջնակետին, որպեսզի տեսնեք դրա մանրամասները, ներառյալ դրա պարամետրերը և պատասխանները: Մեր օրինակում մենք կարող ենք տեսնել բոլոր մոդուլները և դրանց համապատասխան վերջնակետերը, ինչպես նաև դրանց գործողությունների համառոտ նկարագրությունը: Օրինակ, մենք կարող ենք դա տեսնել GET/շտամներ աշխատում է Strains & Cells մոդուլից գրառումներ ստանալու վրա, POST/շտամներ աշխատում է նույն մոդուլում գրառումներ ավելացնելու վրա… և այլն:

Վերջնական կետը փորձարկելու համար սեղմեք «Փորձարկել» կոճակը և մուտքագրեք պահանջվող պարամետրերը (ինչպես ցույց է տրված ստորև ներկայացված սքրինշոթում): Սա հատկապես օգտակար է, երբ մշակում և փորձարկում եք նոր վերջնակետեր՝ նախքան դրանք ձեր հավելվածում ինտեգրելը:

Վերջապես, երբ մուտքագրեք ձեր բոլոր պարամետրերը, սեղմեք «Կատարել” կոճակը՝ հարցումը API-ին ուղարկելու և պատասխանը դիտելու համար:

Այնուհետև կարող եք տեսնել ձեր հարցման արդյունքը բոլոր վատ / չարտոնված / արգելված հարցումների կողքին, եթե այդպիսիք եղել են:

Ավելին, Swagger UI-ն թույլ է տալիս ավտոմատ կերպով ստեղծել փաստաթղթեր՝ հիմնվելով OpenAPI-ի ճշգրտման վրա: Այս փաստաթղթերը կարող են ներբեռնվել տարբեր ձևաչափերով, օրինակ՝ PDF կամ JSON, և կարող են օգտագործվել API-ի հնարավորությունները այլ մշակողների հետ հաղորդելու համար: