Prima di pubblicare un’API o di integrare API di terze parti nei propri sistemi è fondamentale assicurarsi che tutto funzioni. Perciò esistono piattaforme, come Postman, che mettono a disposizione di utenti e sviluppatori un client API che consente di creare, organizzare e testare le API (nonché di monitorarle una volta in produzione).

Che cos’è Postman?

Postman è una piattaforma per lo sviluppo e il test delle API che permette di creare e condividere collezioni, automatizzare i test e monitorare le performance delle Application Programming Interface. 

Come altre piattaforme simili, Postman ha lo scopo di semplificare e rendere più veloce lo sviluppo e il rilascio di nuove API mettendo a disposizione un ambiente che permette di gestire tutti gli aspetti delle proprie API e facilita la collaborazione tra sviluppatori.

Tramite la sua interfaccia grafica è possibile eseguire richieste HTTP, automatizzare i test con script in JavaScript, visualizzare le risposte del server e organizzare le API in collezioni di richieste. Altre funzioni utili della piattaforma includono la simulazione di risposte API, la generazione di documentazione e codice in vari linguaggi di programmazione e la possibilità di esplorare le API pubbliche tramite la Postman API Network.

Le funzioni principali di Postman

In quanto piattaforma API all-in-one, Postman è progettata per sostenere il lavoro degli sviluppatori per tutto il ciclo di vita delle API, dal design al monitoraggio. Prima di tutto, quindi, il suo scopo è quello di fornire un API client, cioè uno strumento che permette di comunicare con le API, e uno spazio in cui conservare e organizzare risposte, modelli e documentazione. 

Perciò, volendo descrivere brevemente Postman, potremmo affidarci alla descrizione delle sue funzioni principali, ovvero:

• API client: Postman è, essenzialmente, un client API che consente di creare, testare, organizzare e riutilizzare facilmente le API. Il client rileva automaticamente il linguaggio della risposta e include il supporto integrato per diversi protocolli di autenticazione;
• API repository: una delle funzioni principali di Postman è quella di conservare, catalogare e condividere tutti i materiali legati allo sviluppo di API all’interno di una piattaforma centralizzata che permette di organizzare specifiche, documentazione, test cases e statistiche;
• Ambiente di lavoro condiviso: altro scopo fondamentale di Postman è quello di facilitare la collaborazione tra sviluppatori (e non solo), cosa che avviene grazie ad ambienti di lavoro condivisi con gli altri membri del team o con utenti esterni.

Un’altra funzione non secondaria del client API di Postman è quella che riguarda la governance. La piattaforma infatti permette di stabilire degli standard interni e di definire modelli da utilizzare in fase di richiesta, risposta e test, facilitando lo sviluppo di API sicure e coerenti ed evitandone la proliferazione.

Piattaforma API Postman: da dove iniziare

Gli strumenti API di Postman sono accessibili tramite applicazione desktop disponibile per Windows, macOS e Linux. Se non si vuole scaricare Postman è possibile utilizzare la versione web based, ma è bene sapere che Postman online non permette di eseguire tutte le operazioni che si possono fare da desktop (per esempio, non è possibile catturare il traffico API via proxy).

L’ambiente di lavoro presenta diverse sezioni, tra cui:

• Workspaces: permettono di organizzare le API e collaborare con altri sviluppatori, sincronizzando il lavoro. Possono essere Interni, cioè accessibili solo al team, Partner, aperti ad alcuni utenti su invito, o Pubblici, cioè accessibili a tutti;
• Request builder: è lo spazio che si usa per configurare le richieste HTTP scegliendo metodo, URL, intestazioni, etc.;
• Response viewer: qui vengono visualizzate le risposte del server (in formato JSON, XML, HTML o di testo);
• Collezioni: sono set organizzati di richieste API che possono essere riutilizzate, automatizzate e condivise;
• Flows: interfaccia grafica per generare flussi automatizzati di test e interazioni tra API;
• APIs: sezione che permette di gestire e documentare le API in maniera centralizzata;
• Monitors: permette di monitorare lo stato delle API e ricevere notifiche in caso di errori.

Muovendosi all’interno delle diverse sezioni è possibile verificare, testare, debuggare e monitorare ogni singola chiamata API. 

I tool di Postman per lo sviluppo delle API

Ma per capire come usare Postman per testare le API, documentarle e monitorane le performance, sarà utile introdurre gli API tool fondamentali messi a disposizione dalla piattaforma:

• Design: l’editor visuale di Postman permette di creare endpoint API e impostarne i parametri, i payload di richiesta e risposta e le impostazioni di autenticazione, documentando il tutto. Le specifiche delle API possono essere progettate utilizzando i formati OpenAPI, RAML, GraphQL o SOAP. Da qui si possono anche generare delle collezioni da utilizzare per mockup, test, monitoraggio o in altre fasi dello sviluppo;
• Test: il test delle API con Postman, automatizzato, permette di impostare flussi di lavoro di integrazione continua e distribuzione continua (CI/CD) e di usare script post-risposta per il debug, ma anche di eseguire test unitari, test di integrazione e test di carico;
• Mock servers: questi server, disponibili anche in locale e in ambiente test, permettono di vedere esattamente come verrà eseguita un’API prima che entri in produzione e di simulare degli endpoint API quando non è possibile inviare richieste a un’API reale;
• Monitors: questi monitor, ospitati sul cloud di Postman, permettono di controllare lo stato e le prestazioni delle API. Possono essere eseguiti su diverse aree geografiche e possono essere integrati con sistemi di alert e dashboard di terze parti;
• API detection: questo strumento permette di intercettare e ispezionare le richieste che transitano tra le applicazioni client e le API, rilevando il traffico HTTP e HTTPS. 

Come utilizzare Postman per il test delle API di Openapi?

Oltre che per gli sviluppatori, Postman è estremamente utile anche per gli utenti delle API. Non solo permette di consultare la documentazione ufficiale relativa alle API di terze parti, e quindi di conoscere URL, endpoint disponibili, metodi HTTP (GET, POST, ecc.) e formati utilizzati (es. JSON), ma anche di testare le API e di valutarne la compatibilità con i propri sistemi tramite i test di integrazione.

In aggiunta agli unit test su singole richieste e risposte, è possibile eseguire test end-to-end, regression test per assicurarsi che le API continuino a funzionare anche dopo modifiche e aggiornamenti vari e test di prestazioni che permettono di simulare il traffico degli utenti e osservare il comportamento delle API sotto carico.

Tutte le API di Openapi sono organizzate in collezioni Postman a disposizione degli utenti. Per testare le singole API basta accedere alla console di Openapi, selezionare l’API da testare e, dalla pagina “Documentazione”, seguire il link a Postman, che conduce direttamente alle nostre API Collections.