LabCollector  erbjuder olika inställningsalternativ. Den är färdig att använda (i den mån det är möjligt) kan dess konfiguration enkelt hanteras av Super-admin för att uppfylla dina specifika laboratoriekrav. Som en del av detta, LabCollector tillhandahåller en Swagger UI som gör att du kan utforska och testa REST API.

Skryt är ett webbaserat gränssnitt som ger ett användarvänligt sätt att interagera med API:et. Det låter användare se tillgängliga API-slutpunkter, deras parametrar och svaren de returnerar. Användare kan också skicka förfrågningar till API:et och se svaren i realtid.

I följande kunskapsbas kommer vi att gå igenom hur du använder LabCollectors Swagger kommer vi också att täcka hur man kommer åt Swagger UI, hur man utforskar och testar tillgängliga API-slutpunkter och hur man genererar dokumentation automatiskt baserat på OpenAPI-specifikationen.

1. Hur kan jag komma åt LabCollectorär Swagger?

2. Hur testar man API-slutpunkter?

1. Hur kan jag komma åt LabCollectorär Swagger?

För att konfigurera ditt webbtjänster API, gå helt enkelt till ADMIN -> ÖVRIGT -> INSTÄLLNING -> Web Services API:

• Ett nytt utbud av applikationer baserat på din LabCollector instans kan implementeras och utvecklas.
• Använda LabCollector som backend-databas kan laboratoriet tillhandahålla fjärrinformation i externa kataloger, biologiska resurser etc.
  
• LabCollector erbjuder API-tjänster som kan hjälpa dig att ansluta en tredjepartsapplikation till LabCollector.

           * För mer information, se denna KB.

Swagger kan lätt nås genom att klicka på den orange ikonen finns till höger om programmet du vill integrera (som visas i skärmdumpen nedan).

När du har klickat på motsvarande Swagger-ikon kommer en ny popup att visas med meddelandet "Det kan ta några sekunder att generera swagger". Sedan generering av OpenAPI-specifikationen kan ta lite tid beroende på komplexiteten hos själva API:et. När du är redo klickar du bara på "Skapa Swagger för den här appen” för att komma åt Swagger UI.

Om du tidigare har skapat en Swagger för en app, klickar du på Swagger-ikonen öppnas en popup som ger dig möjlighet att antingen visa den nuvarande Swagger eller uppdatera den för att generera en ny. Detta är särskilt användbart om ändringar har gjorts i API:et sedan förra gången Swagger genererades.

Popup-fönstret visar också senaste gången Swagger uppdaterades, vilket hjälper dig att hålla reda på Swaggers giltighet och kan vara särskilt användbart för stora API:er som uppdateras ofta.

Anta till exempel att du har gjort några ändringar i din LabCollector API-slutpunkter, som att lägga till eller ändra parametrar, och du vill säkerställa att Swagger exakt återspeglar dessa ändringar. I så fall kan du helt enkelt uppdatera Swagger genom att klicka på uppdateringsknappen, och en ny Swagger kommer att genereras med den uppdaterade informationen.

1. Hur testar man API-slutpunkter?

När du har skapat en Swagger för din valda app kommer du automatiskt att omdirigeras till Swagger UI-gränssnittet, som visar en lista över tillgängliga API-slutpunkter på skärmens vänstra sida (som visas i skärmdumpen nedan). Det här användarvänliga gränssnittet låter dig enkelt utforska API:ets möjligheter, testa det och generera dokumentation baserad på OpenAPI-specifikationen.

Klicka sedan på en slutpunkt för att se dess detaljer, inklusive dess parametrar och svaren den returnerar. I vårt exempel kan vi se alla moduler och deras motsvarande slutpunkter, tillsammans med en kort beskrivning av deras åtgärd. Det kan vi till exempel se GET/stammar arbetar med att hämta poster från modulen Strains & Cells, POST/stammar arbetar med att lägga till poster till samma modul... osv.

För att testa en slutpunkt, klicka på "Testa”-knappen och ange de nödvändiga parametrarna (som visas i skärmdumpen nedan). Detta är särskilt användbart när du utvecklar och testar nya slutpunkter innan du integrerar dem i din applikation.

Slutligen, när du har angett alla dina parametrar, klicka på "Utförande”-knappen för att skicka begäran till API:t och se svaret.

Du kan sedan se resultatet av din förfrågan, tillsammans med alla dåliga / obehöriga / förbjudna förfrågningar om det fanns några.

Dessutom låter Swagger-gränssnittet dig generera dokumentation automatiskt baserat på OpenAPI-specifikationen. Den här dokumentationen kan laddas ner i olika format, såsom PDF eller JSON, och kan användas för att kommunicera API:s möjligheter till andra utvecklare.