LabCollector  pakub erinevaid seadistusvõimalusi. See on kasutusvalmis (niivõrd kui see on võimalik), saab selle konfiguratsiooni hõlpsasti hallata Super-administraator et täita teie spetsiifilisi laborinõudeid. Selle osana LabCollector annab Swagger kasutajaliides mis võimaldab teil uurida ja testida REST API.

Swagger on veebipõhine liides, mis pakub kasutajasõbralikku viisi API-ga suhtlemiseks. See võimaldab kasutajatel vaadata saadaolevaid API lõpp-punkte, nende parameetreid ja vastuseid, mida nad tagastavad. Kasutajad saavad saata API-le taotlusi ja vaadata vastuseid reaalajas.

Järgmises teadmistebaasis juhendame teid, kuidas kasutada LabCollector's Swagger, käsitleme ka seda, kuidas pääseda juurde Swaggeri kasutajaliidesele, kuidas uurida ja testida saadaolevaid API lõpp-punkte ning kuidas luua OpenAPI spetsifikatsiooni alusel automaatselt dokumentatsiooni.

1. Kuidas ma pääsen? LabCollectoron Swagger?

2. Kuidas testida API lõpp-punkte?

1. Kuidas ma pääsen? LabCollectoron Swagger?

Veebiteenuste API konfigureerimiseks minge lihtsalt aadressile ADMIN -> MUU -> SEADISTUS -> Veebiteenuste API:

• Uus rakenduste valik, mis põhineb teie LabCollector näidet saab rakendada ja arendada.
• Kasutamine LabCollector taustaandmebaasina saab labor pakkuda kaugteavet välistes kataloogides, bioloogilistes ressurssides jne.
  
• LabCollector pakub teile API teenuseid, mis aitavad teil ühendada kolmanda osapoole rakendusega LabCollector.

           * Lisateabe saamiseks vaadake seda KB.

Swaggerile pääseb hõlpsalt juurde, klõpsates oranžil ikoonil mis asub integreeritavast rakendusest paremal (nagu on näidatud alloleval ekraanipildil).

Kui olete klõpsanud vastaval Swaggeri ikoonil, ilmub uus hüpikaken, mis kuvab teate "Swaggeri genereerimine võib võtta mõne sekundi“. Kuna OpenAPI spetsifikatsiooni loomine võib sõltuvalt API keerukusest võtta aega. Kui olete valmis, klõpsake lihtsalt "Looge selle rakenduse jaoks Swagger", et pääseda juurde Swaggeri kasutajaliidesele.

Kui olete varem loonud rakenduse jaoks Swaggeri, avaneb Swaggeri ikoonil klõpsamine hüpikaken, mis annab teile võimaluse kuvada praegune Swagger või värskendada seda uue loomiseks. See on eriti kasulik, kui API-s on pärast viimast Swaggeri genereerimist tehtud muudatusi.

Hüpikaknas kuvatakse ka viimane kord, kui Swaggeri värskendati, mis aitab teil jälgida Swaggeri kehtivust ja võib olla eriti kasulik suurte API-de puhul, mida sageli värskendatakse.

Oletagem näiteks, et olete omas teinud mõned muudatused LabCollector API lõpp-punktid, nagu parameetrite lisamine või muutmine, ja soovite tagada, et Swagger kajastaks neid muudatusi täpselt. Sel juhul saate Swaggeri lihtsalt värskendada, klõpsates värskendamisnupul ja värskendatud teabega genereeritakse uus Swagger.

1. Kuidas testida API lõpp-punkte?

Kui olete oma valitud rakenduse jaoks Swaggeri loonud, suunatakse teid automaatselt Swaggeri kasutajaliidese liidesesse, mis kuvab ekraani vasakus servas saadaolevate API lõpp-punktide loendi (nagu on näidatud alloleval ekraanipildil). See kasutajasõbralik liides võimaldab hõlpsasti uurida API võimalusi, seda testida ja luua OpenAPI spetsifikatsioonil põhinevaid dokumente.

Seejärel klõpsake lõpp-punktil, et vaadata selle üksikasju, sealhulgas selle parameetreid ja vastuseid, mida see tagastab. Meie näites näeme kõiki mooduleid ja neile vastavaid lõpp-punkte koos nende tegevuse lühikirjeldusega. Näiteks näeme seda GET/tüved töötab kirjete hankimisel moodulist Tüved ja rakud, POST/tüved töötab kirjete lisamisel samasse moodulisse jne.

Lõpp-punkti testimiseks klõpsake nuppu "Proovi” nuppu ja sisestage vajalikud parameetrid (nagu on näidatud alloleval ekraanipildil). See on eriti kasulik uute lõpp-punktide väljatöötamisel ja testimisel enne nende oma rakendusse integreerimist.

Lõpuks, kui olete kõik parameetrid sisestanud, klõpsake nuppu "Täitma” nuppu, et saata taotlus API-le ja vaadata vastust.

Seejärel näete oma päringu tulemust koos kõigi halbade / volitamata / keelatud taotlustega, kui neid oli.

Lisaks võimaldab Swaggeri kasutajaliides teil OpenAPI spetsifikatsiooni alusel dokumentatsiooni automaatselt genereerida. Seda dokumentatsiooni saab alla laadida erinevates vormingutes, näiteks PDF- või JSON-vormingus, ja seda saab kasutada API võimalustest teistele arendajatele edastamiseks.