LabCollector  oferece várias opções de configuração. Está pronto para uso (na medida do possível), sua configuração pode ser facilmente gerenciada pelo Superadministrador para atender aos requisitos específicos do seu laboratório. Como parte disso, LabCollector fornece uma IU Swagger que permite explorar e testar o API REST.

Swagger é uma interface baseada na web que fornece uma maneira amigável de interagir com a API. Ele permite que os usuários visualizem os endpoints da API disponíveis, seus parâmetros e as respostas que eles retornam. Os usuários também podem enviar solicitações à API e visualizar as respostas em em tempo real.

Na base de conhecimento a seguir, orientaremos você sobre como usar o LabCollectordo Swagger, também abordaremos como acessar a UI do Swagger, como explorar e testar os endpoints de API disponíveis e como gerar documentação automaticamente com base na especificação OpenAPI.

1. Como posso acessar LabCollectorÉ arrogância?

2. Como testar endpoints de API?

1. Como posso acessar LabCollectorÉ arrogância?

Para configurar sua API de serviços web, basta acessar ADMIN -> OUTRO -> CONFIGURAÇÃO -> API de serviços da Web:

• Uma nova gama de aplicações baseadas no seu LabCollector instância pode ser implementada e desenvolvida.
• utilização LabCollector como banco de dados backend, o laboratório pode fornecer informações remotas em catálogos externos, recursos biológicos, etc.
  
• LabCollector oferece serviços de API que podem ajudá-lo a conectar um aplicativo de terceiros ao LabCollector.

           * Para mais informações, consulte este KB.

O Swagger pode ser facilmente acessado clicando no ícone laranja localizado à direita do Aplicativo que você deseja integrar (conforme mostrado na imagem abaixo).

Depois de clicar no ícone Swagger correspondente, um novo pop-up aparecerá exibindo a mensagem “A geração de arrogância pode levar alguns segundos“. Já que a geração da especificação OpenAPI pode levar algum tempo dependendo da complexidade da própria API. Quando estiver pronto, basta clicar em “Crie Swagger para este aplicativo”Para acessar a IU do Swagger.

Se você já criou um Swagger para um aplicativo, clicar no ícone do Swagger abrirá um pop-up que oferece a opção de mostrar o Swagger atual ou atualizá-lo para gerar um novo. Isto é particularmente útil se tiverem sido feitas alterações na API desde a última vez que o Swagger foi gerado.

O pop-up também exibe a última vez que o Swagger foi atualizado, o que ajuda a acompanhar a validade do Swagger e pode ser especialmente útil para APIs grandes que são atualizadas com frequência.

Por exemplo, suponha que você tenha feito algumas alterações em seu LabCollector Endpoints de API, como adicionar ou modificar parâmetros, e você deseja garantir que o Swagger reflita com precisão essas alterações. Nesse caso, você pode simplesmente atualizar o Swagger clicando no botão atualizar, e um novo Swagger será gerado com as informações atualizadas.

1. Como testar endpoints de API?

Depois de criar um Swagger para o aplicativo escolhido, você será automaticamente redirecionado para a interface Swagger UI, que exibe uma lista de endpoints de API disponíveis no lado esquerdo da tela (conforme mostrado na captura de tela abaixo). Essa interface amigável permite explorar facilmente os recursos da API, testá-la e gerar documentação com base na especificação OpenAPI.

Em seguida, clique em um endpoint para ver seus detalhes, incluindo seus parâmetros e as respostas que ele retorna. Em nosso exemplo, podemos ver todos os módulos e seus endpoints correspondentes, juntamente com uma breve descrição de sua ação. Por exemplo, podemos ver que GET/cepas trabalha na obtenção de registros do módulo Strains & Cells, PÓS/cepas trabalha adicionando registros ao mesmo módulo… etc.

Para testar um endpoint, clique no botão “Experimente”E insira os parâmetros necessários (conforme mostrado na imagem abaixo). Isso é particularmente útil ao desenvolver e testar novos endpoints antes de integrá-los ao seu aplicativo.

Por fim, depois de inserir todos os seus parâmetros, clique no botão “Execute”Para enviar a solicitação à API e visualizar a resposta.

Você poderá então ver o resultado da sua solicitação, juntamente com todas as solicitações incorretas/não autorizadas/proibidas, se houver.

Além disso, a UI do Swagger permite gerar documentação automaticamente com base na especificação OpenAPI. Esta documentação pode ser baixada em vários formatos, como PDF ou JSON, e pode ser usada para comunicar os recursos da API a outros desenvolvedores.