Sommario
Nel presente articolo viene descritto come eseguire un test per verificare il funzionamento del collegamento con Bravo API.
1. Tutorial per test su Bravo API
All’interno di questo capitolo verrà spiegato in semplici passi come testare il funzionamento delle Bravo API. Come strumento di testing è stato utilizzato il tool multipiattaforma PostMan che permette di effettuare testing in maniera semplice e snella.
Per scaricare il tool aprire il seguente link: https://www.getpostman.com/apps.
1.1 Usare Postman per inviare una richiesta di lettura
Come esempio di richiesta di lettura viene utilizzata l’API con endpoint “/api/v1/connectors” già illustrata nel paragrafo 5.1 dell'articolo "Come utilizzare Bravo API" per il recupero dei dati relativi ai connettori generici salvati a database.
Passi:
- Aprire Postman
- Impostare il metodo HTTP su GET
- Compilare il campo URL utilizzando l’indirizzo IP del server dove risiede il servizio Bravo API, la porta specificata nella configurazione del servizio e l’endpoint (In questo caso “/api/v1/connectors”)
- Premere sul pulsante Send
Come è possibile vedere in figura nella scheda Body della risposta, viene restituito l’oggetto JSON contenente la lista dei connettori generici e sulla destra il codice dello stato HTTP (in questo caso 200 OK).
Nota: Gli stessi passi possono essere applicati per testare le altre API che utilizzano il metodo HTTP GET, ad es. gli endpoints “/api/v1/connectors/{id}” per il recupero di informazioni su dispositivi e variabili di un specifico connettore, già illustrati nei paragrafi 5.2 e 5.3 dell'articolo "Come utilizzare Bravo API".
1.2 Usare Postman per inviare una richiesta di creazione
Come esempio di richiesta di creazione viene utilizzata l’API con endpoint “/api/v1/snapshotvalues” già illustrata nel paragrafo 6.1 dell'articolo "Come utilizzare Bravo API" per la creazione di snapshots contenenti valori per le variabili di un connettore generico.
Passi:
- Aprire Postman
- Compilare il campo URL utilizzando l’indirizzo IP del server dove risiede il servizio Bravo API, la porta specificata nella configurazione del servizio e l’endpoint (In questo caso “/api/v1/ snapshotvalues”)
- Impostare il metodo HTTP su POST
- Fare clic sulla scheda Body (Corpo)
- Selezionare il pulsante di opzione raw (non elaborato)
- Impostare il tipo su JSON (application/json)
- Inserire all’interno della scheda l’oggetto JSON come illustrato nel paragrafo 6.1 dell'articolo "Come utilizzare Bravo API" (vedi figura sotto).
Quindi la chiave esterna del connettore generico e la lista dei valori per ogni variabile specificata - Premere sul pulsante Send
Come è possibile vedere in figura nella scheda Body della risposta, viene restituito l’oggetto JSON contenente in questo caso lo stato HTTP (in questo caso 201 Created, visibile anche in alto a destra), il codice APICustomError con valore 1000 (“NoError”) e il response data nullo poiché l’operazione di creazione non ritorna nessun valore.
Commenti