LabCollector  biedt diverse opstellingsmogelijkheden. Het is klaar voor gebruik (voor zover mogelijk) kan de configuratie ervan eenvoudig worden beheerd door de Superbeheerder om aan uw specifieke laboratoriumvereisten te voldoen. Als onderdeel hiervan, LabCollector biedt Swagger-gebruikersinterface waarmee u de REST API.

Branie is een webgebaseerde interface die een gebruiksvriendelijke manier biedt om met de API te communiceren. Hiermee kunnen gebruikers de beschikbare API-eindpunten, hun parameters en de reacties die ze retourneren bekijken. Gebruikers kunnen ook verzoeken naar de API sturen en de antwoorden bekijken real-time.

In de volgende Knowledge Base laten we u zien hoe u de LabCollector's Swagger, zullen we ook bespreken hoe u toegang krijgt tot de Swagger-gebruikersinterface, hoe u de beschikbare API-eindpunten kunt verkennen en testen, en hoe u automatisch documentatie kunt genereren op basis van de OpenAPI-specificatie.

1. Hoe krijg ik toegang? LabCollector's Swagger?

2. Hoe API-eindpunten testen?

1. Hoe krijg ik toegang? LabCollector's Swagger?

Om uw webservices-API te configureren, gaat u eenvoudigweg naar BEHEERDER -> ANDERE -> INSTELLING -> Web Services API:

• Een nieuw scala aan toepassingen op basis van uw LabCollector exemplaar kan worden geïmplementeerd en ontwikkeld.
• gebruik LabCollector als backend-database kan het laboratorium informatie op afstand verstrekken in externe catalogi, biologische bronnen, enz.
  
• LabCollector biedt u API-diensten waarmee u een applicatie van derden kunt verbinden LabCollector.

           * Raadpleeg dit voor meer informatie KB.

Swagger is eenvoudig toegankelijk door op het oranje pictogram te klikken bevindt zich rechts van de applicatie die u wilt integreren (zoals weergegeven in de onderstaande schermafbeelding).

Nadat u op het overeenkomstige Swagger-pictogram hebt geklikt, verschijnt er een nieuwe pop-up met het bericht “Het genereren van branie kan enkele seconden duren“. Omdat het genereren van de OpenAPI-specificatie enige tijd kan duren, afhankelijk van de complexiteit van de API zelf. Als u klaar bent, klikt u eenvoudig op “Maak Swagger voor deze app' om toegang te krijgen tot de Swagger-gebruikersinterface.

Als u eerder een Swagger voor een app hebt gemaakt, wordt door op het Swagger-pictogram te klikken een pop-up geopend waarin u de optie krijgt om de huidige Swagger weer te geven of deze te vernieuwen om een ​​nieuwe te genereren. Dit is met name handig als er wijzigingen zijn aangebracht in de API sinds de laatste keer dat de Swagger is gegenereerd.

De pop-up geeft ook de laatste keer weer dat de Swagger is bijgewerkt, waardoor u de geldigheid van de Swagger kunt bijhouden en vooral handig kan zijn voor grote API's die regelmatig worden bijgewerkt.

Stel dat u bijvoorbeeld enkele wijzigingen heeft aangebracht in uw LabCollector API-eindpunten, zoals het toevoegen of wijzigen van parameters, en u wilt ervoor zorgen dat de Swagger deze wijzigingen nauwkeurig weergeeft. In dat geval kunt u de Swagger eenvoudig vernieuwen door op de knop Vernieuwen te klikken. Er wordt dan een nieuwe Swagger gegenereerd met de bijgewerkte informatie.

1. Hoe API-eindpunten testen?

Zodra u een Swagger voor de door u gekozen app heeft gemaakt, wordt u automatisch doorgestuurd naar de Swagger UI-interface, die aan de linkerkant van het scherm een ​​lijst met beschikbare API-eindpunten weergeeft (zoals weergegeven in de onderstaande schermafbeelding). Met deze gebruiksvriendelijke interface kunt u eenvoudig de mogelijkheden van de API verkennen, testen en documentatie genereren op basis van de OpenAPI-specificatie.

Klik vervolgens op een eindpunt om de details ervan te bekijken, inclusief de parameters en de antwoorden die het retourneert. In ons voorbeeld kunnen we alle modules en hun bijbehorende eindpunten zien, naast een korte beschrijving van hun actie. Dat kunnen wij bijvoorbeeld zien GET/stammen werkt aan het ophalen van records uit de module Stammen & Cellen, POST/spanningen werkt aan het toevoegen van records aan dezelfde module... enz.

Om een ​​eindpunt te testen, klikt u op de “Probeer het' en voer de vereiste parameters in (zoals weergegeven in de onderstaande schermafbeelding). Dit is met name handig bij het ontwikkelen en testen van nieuwe eindpunten voordat u ze in uw toepassing integreert.

Nadat u ten slotte al uw parameters heeft ingevoerd, klikt u op de knop “Uitvoeren' om het verzoek naar de API te sturen en het antwoord te bekijken.

U kunt dan het resultaat van uw verzoek zien, naast alle slechte/ongeautoriseerde/verboden verzoeken als die er zijn.

Bovendien kunt u met de Swagger UI automatisch documentatie genereren op basis van de OpenAPI-specificatie. Deze documentatie kan worden gedownload in verschillende formaten, zoals PDF of JSON, en kan worden gebruikt om de mogelijkheden van de API aan andere ontwikkelaars te communiceren.