LabCollector  ofrece varias opciones de configuración. Está listo para usar (en la medida de lo posible), su configuración puede ser fácilmente gestionada por el superadministrador para cumplir con los requisitos específicos de su laboratorio. Como parte de esto, LabCollector proporciona una IU de Swagger que le permite explorar y probar el REST API.

Pavonearse es una interfaz basada en web que proporciona una forma fácil de interactuar con la API. Permite a los usuarios ver los puntos finales de API disponibles, sus parámetros y las respuestas que devuelven. Los usuarios también pueden enviar solicitudes a la API y ver las respuestas en en tiempo real.

En la siguiente base de conocimientos, le explicaremos cómo utilizar el LabCollectorEn Swagger, también cubriremos cómo acceder a la interfaz de usuario de Swagger, cómo explorar y probar los puntos finales de API disponibles y cómo generar documentación automáticamente según la especificación OpenAPI.

1. ¿Cómo puedo acceder? LabCollector¿Es arrogancia?

2. ¿Cómo probar los puntos finales API?

1. ¿Cómo puedo acceder? LabCollector¿Es arrogancia?

Para configurar su API de servicios web, simplemente vaya a ADMINISTRADOR -> OTROS -> CONFIGURACIÓN -> API de servicios web:

• Una nueva gama de aplicaciones basadas en su LabCollector instancia puede ser implementada y desarrollada.
• Usar LabCollector como base de datos backend, el laboratorio puede proporcionar información remota en catálogos externos, recursos biológicos, etc.
  
• LabCollector le ofrece servicios API que pueden ayudarle a conectar una aplicación de terceros a LabCollector.

           * Para obtener más información, consulte este KB.

Se puede acceder fácilmente a Swagger haciendo clic en el icono naranja ubicado a la derecha de la aplicación que desea integrar (como se muestra en la captura de pantalla a continuación).

Una vez que haya hecho clic en el icono Swagger correspondiente, aparecerá una nueva ventana emergente que muestra el mensaje "Generar arrogancia podría llevar unos segundos“. Dado que generar la especificación OpenAPI puede llevar algún tiempo dependiendo de la complejidad de la propia API. Una vez que esté listo, simplemente haga clic en “Crea Swagger para esta aplicación”para acceder a la interfaz de usuario de Swagger.

Si anteriormente creó un Swagger para una aplicación, al hacer clic en el icono de Swagger se abrirá una ventana emergente que le dará la opción de mostrar el Swagger actual o actualizarlo para generar uno nuevo. Esto es particularmente útil si se han realizado cambios en la API desde la última vez que se generó Swagger.

La ventana emergente también muestra la última vez que se actualizó Swagger, lo que le ayuda a realizar un seguimiento de la validez de Swagger y puede ser especialmente útil para API grandes que se actualizan con frecuencia.

Por ejemplo, supongamos que ha realizado algunos cambios en su LabCollector Puntos finales de API, como agregar o modificar parámetros, y desea asegurarse de que Swagger refleje con precisión estos cambios. En ese caso, simplemente puede actualizar Swagger haciendo clic en el botón Actualizar y se generará un nuevo Swagger con la información actualizada.

1. ¿Cómo probar los puntos finales API?

Una vez que haya creado un Swagger para la aplicación elegida, será redirigido automáticamente a la interfaz de usuario de Swagger, que muestra una lista de puntos finales API disponibles en el lado izquierdo de la pantalla (como se muestra en la captura de pantalla a continuación). Esta interfaz fácil de usar le permite explorar fácilmente las capacidades de la API, probarla y generar documentación basada en la especificación OpenAPI.

Luego, haga clic en un punto final para ver sus detalles, incluidos sus parámetros y las respuestas que devuelve. En nuestro ejemplo, podemos ver todos los módulos y sus puntos finales correspondientes, junto con una breve descripción de su acción. Por ejemplo, podemos ver que GET/cepas trabaja en la obtención de registros del módulo Strains & Cells, POST/cepas trabaja para agregar registros al mismo módulo... etc.

Para probar un punto final, haga clic en "Pruébalo”e ingrese los parámetros requeridos (como se muestra en la captura de pantalla a continuación). Esto es particularmente útil al desarrollar y probar nuevos puntos finales antes de integrarlos en su aplicación.

Finalmente, una vez que haya ingresado todos sus parámetros, haga clic en "Implementación”Para enviar la solicitud a la API y ver la respuesta.

Luego podrá ver el resultado de su solicitud, junto con todas las solicitudes incorrectas, no autorizadas o prohibidas, si las hubiera.

Además, la interfaz de usuario de Swagger le permite generar documentación automáticamente según la especificación OpenAPI. Esta documentación se puede descargar en varios formatos, como PDF o JSON, y se puede utilizar para comunicar las capacidades de la API a otros desarrolladores.