LabCollector  offre diverses options de configuration. Il est prêt à l'emploi (dans la mesure du possible), sa configuration peut être facilement gérée par le Super-administrateur afin de répondre aux exigences spécifiques de votre laboratoire. Dans le cadre de cela, LabCollector fournit une Interface utilisateur Swagger qui vous permet d'explorer et de tester le API REST.

Swagger est une interface Web qui offre un moyen convivial d'interagir avec l'API. Il permet aux utilisateurs d'afficher les points de terminaison d'API disponibles, leurs paramètres et les réponses qu'ils renvoient. Les utilisateurs peuvent également envoyer des requêtes à l'API et afficher les réponses dans en temps réel.

Dans la base de connaissances suivante, nous vous expliquerons comment utiliser le LabCollectorDans Swagger, nous expliquerons également comment accéder à l'interface utilisateur de Swagger, comment explorer et tester les points de terminaison d'API disponibles et comment générer automatiquement une documentation basée sur la spécification OpenAPI.

1. Comment puis-je accéder LabCollectorC'est Swagger ?

2. Comment tester les points de terminaison de l'API ?

1. Comment puis-je accéder LabCollectorC'est Swagger ?

Pour configurer votre API de services Web, rendez-vous simplement sur ADMIN -> AUTRE -> CONFIGURATION -> API de services Web:

• Une nouvelle gamme d'applications basées sur votre LabCollector Cette instance peut être implémentée et développée.
• En utilisant LabCollector en tant que base de données backend, le laboratoire peut fournir des informations à distance dans des catalogues externes, des ressources biologiques, etc.
  
• LabCollector vous propose des services API qui peuvent vous aider à connecter une application tierce à LabCollector.

           * Pour plus d'informations, veuillez consulter ce KB.

Swagger est facilement accessible en cliquant sur l'icône orange situé à droite de l'application que vous souhaitez intégrer (comme indiqué dans la capture d'écran ci-dessous).

Une fois que vous aurez cliqué sur l’icône Swagger correspondante, une nouvelle popup apparaîtra affichant le message «Générer du swagger peut prendre quelques secondes« . Étant donné que la génération de la spécification OpenAPI peut prendre un certain temps en fonction de la complexité de l'API elle-même. Une fois que vous êtes prêt, cliquez simplement sur «Créez Swagger pour cette application" pour accéder à l'interface utilisateur Swagger.

Si vous avez déjà créé un Swagger pour une application, cliquer sur l'icône Swagger ouvrira une fenêtre contextuelle qui vous donnera la possibilité d'afficher le Swagger actuel ou de l'actualiser pour en générer un nouveau. Ceci est particulièrement utile si des modifications ont été apportées à l'API depuis la dernière génération du Swagger.

La fenêtre contextuelle affiche également la dernière fois que Swagger a été mis à jour, ce qui vous aide à suivre la validité de Swagger et peut être particulièrement utile pour les grandes API fréquemment mises à jour.

Par exemple, supposons que vous ayez apporté des modifications à votre LabCollector Les points de terminaison de l'API, tels que l'ajout ou la modification de paramètres, et vous souhaitez vous assurer que Swagger reflète avec précision ces modifications. Dans ce cas, vous pouvez simplement actualiser le Swagger en cliquant sur le bouton d'actualisation, et un nouveau Swagger sera généré avec les informations mises à jour.

1. Comment tester les points de terminaison de l'API ?

Une fois que vous avez créé un Swagger pour l'application de votre choix, vous serez automatiquement redirigé vers l'interface utilisateur de Swagger, qui affiche une liste des points de terminaison d'API disponibles sur le côté gauche de l'écran (comme indiqué dans la capture d'écran ci-dessous). Cette interface conviviale vous permet d'explorer facilement les capacités de l'API, de la tester et de générer une documentation basée sur la spécification OpenAPI.

Ensuite, cliquez sur un point de terminaison pour afficher ses détails, y compris ses paramètres et les réponses qu'il renvoie. Dans notre exemple, nous pouvons voir tous les modules et leurs points de terminaison correspondants, ainsi qu'une brève description de leur action. Par exemple, nous pouvons voir que GET/souches travaille à obtenir des enregistrements du module Souches & Cellules, POST/souches travaille sur l'ajout d'enregistrements dans le même module… etc.

Pour tester un point de terminaison, cliquez sur le bouton «Essaye le" et entrez les paramètres requis (comme indiqué dans la capture d'écran ci-dessous). Ceci est particulièrement utile lors du développement et du test de nouveaux points de terminaison avant de les intégrer dans votre application.

Enfin, une fois que vous avez renseigné tous vos paramètres, cliquez sur le bouton «Exécution" pour envoyer la requête à l'API et afficher la réponse.

Vous pouvez alors voir le résultat de votre demande, ainsi que toutes les demandes incorrectes/non autorisées/interdites, le cas échéant.

De plus, l'interface utilisateur Swagger vous permet de générer automatiquement une documentation basée sur la spécification OpenAPI. Cette documentation peut être téléchargée dans différents formats, tels que PDF ou JSON, et peut être utilisée pour communiquer les capacités de l'API à d'autres développeurs.