LabCollector  tarjoaa erilaisia ​​asennusvaihtoehtoja. Se on käyttövalmis (jos mahdollista), sen konfigurointia voidaan helposti hallita Super-Admin täyttääksesi erityiset laboratoriovaatimukset. Osana tätä LabCollector tarjoaa a Swagger UI jonka avulla voit tutkia ja testata REST API.

Rehvastella on verkkopohjainen käyttöliittymä, joka tarjoaa käyttäjäystävällisen tavan olla vuorovaikutuksessa API:n kanssa. Sen avulla käyttäjät voivat tarkastella käytettävissä olevia API-päätepisteitä, niiden parametreja ja palauttamia vastauksia. Käyttäjät voivat myös lähettää pyyntöjä API:lle ja tarkastella vastauksia sisään reaaliaikainen.

Seuraavassa tietokannassa opastamme sinua käyttämään LabCollector's Swaggerissa, käsittelemme myös Swaggerin käyttöliittymän käyttämistä, käytettävissä olevien API-päätepisteiden tutkimista ja testaamista sekä dokumentaation luomista automaattisesti OpenAPI-spesifikaatioiden perusteella.

1. Miten pääsen LabCollectorOnko Swagger?

2. Kuinka testata API-päätepisteitä?

1. Miten pääsen LabCollectorOnko Swagger?

Voit määrittää verkkopalveluiden sovellusliittymän siirtymällä osoitteeseen JÄRJESTELMÄNVALVOJA -> MUU -> ASETUS -> Web Services API:

• Uusi valikoima sovelluksia, jotka perustuvat sinun LabCollector esimerkki voidaan toteuttaa ja kehittää.
• Käyttäminen LabCollector taustatietokantana laboratorio voi tarjota etätietoja ulkoisista luetteloista, biologisista resursseista jne.
  
• LabCollector tarjoaa sinulle API-palveluita, joiden avulla voit yhdistää kolmannen osapuolen sovelluksen LabCollector.

           * Lisätietoja saat tästä KB.

Swaggeriin pääsee helposti klikkaamalla oranssia kuvaketta joka sijaitsee integroitavan sovelluksen oikealla puolella (kuten alla olevassa kuvakaappauksessa näkyy).

Kun olet napsauttanut vastaavaa Swagger-kuvaketta, näkyviin tulee uusi ponnahdusikkuna, jossa näkyy viesti "Swaggerin luominen voi kestää muutaman sekunnin". Koska OpenAPI-määrityksen luominen voi kestää jonkin aikaa riippuen itse API:n monimutkaisuudesta. Kun olet valmis, napsauta "Luo Swagger tälle sovellukselle" päästäksesi Swagger-käyttöliittymään.

Jos olet aiemmin luonut Swaggerin sovellukselle, Swagger-kuvakkeen napsauttaminen avaa ponnahdusikkunan, jossa voit joko näyttää nykyisen Swaggerin tai päivittää sen luodaksesi uuden. Tämä on erityisen hyödyllistä, jos API:aan on tehty muutoksia viimeisen Swaggerin luomisen jälkeen.

Ponnahdusikkuna näyttää myös Swaggerin viimeisimmän päivityksen, mikä auttaa sinua seuraamaan Swaggerin voimassaoloa ja voi olla erityisen hyödyllinen suurille API:ille, joita päivitetään usein.

Oletetaan esimerkiksi, että olet tehnyt joitain muutoksia omaan LabCollector API-päätepisteitä, kuten parametrien lisääminen tai muokkaaminen, ja haluat varmistaa, että Swagger heijastaa näitä muutoksia tarkasti. Siinä tapauksessa voit yksinkertaisesti päivittää Swaggerin napsauttamalla päivityspainiketta, jolloin päivitetyillä tiedoilla luodaan uusi Swagger.

1. Kuinka testata API-päätepisteitä?

Kun olet luonut Swaggerin valitsemallesi sovellukselle, sinut ohjataan automaattisesti Swagger-käyttöliittymän käyttöliittymään, joka näyttää luettelon käytettävissä olevista API-päätepisteistä näytön vasemmassa reunassa (kuten alla olevassa kuvakaappauksessa). Tämän käyttäjäystävällisen käyttöliittymän avulla voit helposti tutkia API:n ominaisuuksia, testata sitä ja luoda dokumentaatiota OpenAPI-spesifikaatioiden perusteella.

Napsauta sitten päätepistettä nähdäksesi sen tiedot, mukaan lukien sen parametrit ja sen palauttamat vastaukset. Esimerkissämme näemme kaikki moduulit ja niitä vastaavat päätepisteet sekä lyhyen kuvauksen niiden toiminnasta. Esimerkiksi voimme nähdä sen GET/kannat pyrkii saamaan tietueita moduulista Strains & Cells, POST/kannat toimii tietueiden lisäämisessä samaan moduuliin… jne.

Testaaksesi päätepistettä, napsauta "Kokeile sitä” -painiketta ja syötä tarvittavat parametrit (kuten alla olevassa kuvakaappauksessa näkyy). Tämä on erityisen hyödyllistä kehitettäessä ja testattaessa uusia päätepisteitä ennen niiden integrointia sovellukseesi.

Lopuksi, kun olet syöttänyt kaikki parametrit, napsauta "Suorittaa” -painiketta lähettääksesi pyynnön API:lle ja tarkastellaksesi vastausta.

Näet sitten pyyntösi tuloksen sekä kaikki huonot / luvattomat / kielletyt pyynnöt, jos niitä on ollut.

Lisäksi Swagger-käyttöliittymä mahdollistaa dokumentaation luomisen automaattisesti OpenAPI-spesifikaatioiden perusteella. Tämä dokumentaatio voidaan ladata eri muodoissa, kuten PDF- tai JSON-muodossa, ja sitä voidaan käyttää sovellusliittymän ominaisuuksien viestimiseen muille kehittäjille.