LabCollector  offre varie opzioni di configurazione. È pronto per l'uso (per quanto possibile), la sua configurazione può essere facilmente gestita dal Super amministratore per soddisfare le vostre specifiche esigenze di laboratorio. Come parte di questo, LabCollector fornisce un Interfaccia utente spavalda che ti consente di esplorare e testare il API REST.

pavoneggiarsi è un'interfaccia basata sul Web che fornisce un modo intuitivo per interagire con l'API. Consente agli utenti di visualizzare gli endpoint API disponibili, i relativi parametri e le risposte che restituiscono. Gli utenti possono anche inviare richieste all'API e visualizzare le risposte in tempo reale.

Nella seguente Knowledge Base ti spiegheremo come utilizzare LabCollectordi Swagger, tratteremo anche come accedere all'interfaccia utente di Swagger, come esplorare e testare gli endpoint API disponibili e come generare automaticamente la documentazione in base alla specifica OpenAPI.

1. Come posso accedere LabCollectorè Spavaldo?

2. Come testare gli endpoint API?

1. Come posso accedere LabCollectorè Spavaldo?

Per configurare l'API dei tuoi servizi web, vai semplicemente su AMMINISTRAZIONE -> ALTRO -> IMPOSTAZIONE -> API di servizi Web:

• Una nuova gamma di applicazioni basate sul tuo LabCollector esempio può essere implementato e sviluppato.
• utilizzando LabCollector come database backend, il laboratorio può fornire informazioni remote in cataloghi esterni, risorse biologiche, ecc.
  
• LabCollector ti offre servizi API che possono aiutarti a connettere un'applicazione di terze parti a LabCollector.

           * Per ulteriori informazioni, fare riferimento a questo KB.

È possibile accedere facilmente a Swagger facendo clic sull'icona arancione situato a destra dell'Applicazione che desideri integrare (come mostrato nello screenshot qui sotto).

Dopo aver fatto clic sull'icona Swagger corrispondente, verrà visualizzato un nuovo popup che mostra il messaggio "La generazione di spavalderia potrebbe richiedere alcuni secondi“. Poiché la generazione della specifica OpenAPI può richiedere del tempo a seconda della complessità dell'API stessa. Una volta che sei pronto, fai semplicemente clic su "Crea Swagger per questa app" per accedere all'interfaccia utente di Swagger.

Se hai precedentemente creato uno Swagger per un'app, facendo clic sull'icona Swagger si aprirà un popup che ti darà la possibilità di mostrare lo Swagger corrente o aggiornarlo per generarne uno nuovo. Ciò è particolarmente utile se sono state apportate modifiche all'API dall'ultima volta che è stato generato Swagger.

Il popup mostra anche l'ultima volta che Swagger è stato aggiornato, il che ti aiuta a tenere traccia della validità di Swagger e può essere particolarmente utile per le API di grandi dimensioni che vengono aggiornate frequentemente.

Ad esempio, supponiamo di aver apportato alcune modifiche al tuo file LabCollector Endpoint API, come l'aggiunta o la modifica di parametri, e vuoi assicurarti che Swagger rifletta accuratamente queste modifiche. In tal caso, puoi semplicemente aggiornare Swagger facendo clic sul pulsante di aggiornamento e verrà generato un nuovo Swagger con le informazioni aggiornate.

1. Come testare gli endpoint API?

Dopo aver creato uno Swagger per l'app scelta, verrai reindirizzato automaticamente all'interfaccia utente di Swagger, che visualizza un elenco di endpoint API disponibili sul lato sinistro dello schermo (come mostrato nello screenshot seguente). Questa interfaccia intuitiva ti consente di esplorare facilmente le funzionalità dell'API, testarla e generare documentazione basata sulle specifiche OpenAPI.

Quindi, fai clic su un endpoint per visualizzarne i dettagli, inclusi i parametri e le risposte restituite. Nel nostro esempio, possiamo vedere tutti i moduli e i relativi endpoint corrispondenti, insieme a una breve descrizione della loro azione. Ad esempio, possiamo vederlo OTTIENI/ceppi lavora per ottenere record dal modulo Strains & Cells, POST/ceppi funziona aggiungendo record allo stesso modulo... ecc.

Per testare un endpoint, fare clic su "Provalo" e inserisci i parametri richiesti (come mostrato nello screenshot qui sotto). Ciò è particolarmente utile quando si sviluppano e si testano nuovi endpoint prima di integrarli nell'applicazione.

Infine, una volta inseriti tutti i parametri, clicca sul pulsante “Eseguire" per inviare la richiesta all'API e visualizzare la risposta.

Potrai quindi vedere il risultato della tua richiesta, insieme a tutte le richieste errate/non autorizzate/proibite, se presenti.

Inoltre, l'interfaccia utente Swagger consente di generare automaticamente la documentazione in base alle specifiche OpenAPI. Questa documentazione può essere scaricata in vari formati, come PDF o JSON, e può essere utilizzata per comunicare le funzionalità dell'API ad altri sviluppatori.