Postman API Calls

Introduzione

Questo articolo approfondirà i fondamenti dei servizi web, fornendole le conoscenze e gli esempi pratici necessari per diventare esperto nelle chiamate API di Postman.

I servizi web sono stati una componente cruciale delle applicazioni moderne per oltre due decenni, evolvendo significativamente dagli inizi degli anni 2000. Questi servizi si basano fortemente sulle API (Application Programming Interfaces) per comunicare e scambiare dati. In qualità di sviluppatori e tester, abbiamo bisogno di strumenti robusti per interagire efficacemente con queste API. Questo è dove entra in gioco Postman.

La Web UI di DataSunrise si basa su chiamate API utilizzando richieste POST basate su RPC e JSON. Anche quando viene eseguito un comando nell’interfaccia della riga di comando (CLI), il JSON richiesto viene creato in base alle opzioni del comando, che viene poi passato al backend per chiamare l’RPC richiesto. Questo processo viene utilizzato anche nella Console Web per creare e gestire regole e altre configurazioni.

Che Cos’è Postman?

Postman è uno strumento popolare per lo sviluppo e il test delle API che semplifica il processo di invio delle richieste, analisi delle risposte e gestione delle API. Fornisce un’interfaccia user-friendly per creare ed eseguire chiamate API, facilitando il lavoro degli sviluppatori con i servizi web.

Comprendere i Servizi Web

I servizi web sono applicazioni o componenti che comunicano attraverso reti utilizzando protocolli web standard. Questi servizi consentono ai diversi sistemi software di interagire e scambiare dati senza problemi, indipendentemente dalle loro tecnologie o piattaforme sottostanti.

Caratteristiche Chiave dei Servizi Web

1. Indipendenza dalla Piattaforma: I servizi web possono essere accessibili da qualsiasi dispositivo o sistema operativo con connettività a internet.
2. Interoperabilità: Consentono a sistemi diversi di comunicare utilizzando protocolli e formati dati standardizzati.
3. Scalabilità: I servizi web possono gestire più client e crescere con l’aumento della domanda.
4. Riutilizzabilità: Una volta creati, i servizi web possono essere utilizzati da più applicazioni, promuovendo il riutilizzo del codice e l’efficienza.

Che Cos’è l’RPC?

Il Remote Procedure Call (RPC) è un protocollo (JSON-RPC) che consente a un programma di eseguire una procedura o funzione su un altro computer come se fosse una chiamata di procedura locale. L’RPC è una delle prime forme di calcolo distribuito e ha svolto un ruolo significativo nello sviluppo dei servizi web.

Caratteristiche Chiave dell’RPC:

1. Trasparenza della Posizione: Il programma chiamante non ha bisogno di conoscere la posizione fisica della procedura chiamata.
2. Comunicazione Sincrona: L’RPC di solito segue un modello di richiesta-risposta, in cui il chiamante attende la risposta prima di continuare.
3. Orientamento alle Procedure: L’RPC si concentra sulla chiamata di procedure o funzioni specifiche su sistemi remoti.

Comprendere le API

Un’Application Programming Interface (API) è un insieme di regole, protocolli e strumenti che consente a diverse applicazioni software di comunicare tra loro. Le API definiscono i metodi e i formati dati che le applicazioni possono utilizzare per richiedere e scambiare informazioni.

Tipi di API

1. SOAP (Simple Object Access Protocol): Un protocollo che utilizza XML per lo scambio di dati strutturati.
2. REST (Representational State Transfer): Uno stile architetturale che utilizza i metodi HTTP standard per la comunicazione.
3. GraphQL: Un linguaggio di interrogazione per le API che consente ai client di richiedere i dati specifici di cui hanno bisogno.

Perché le API Sono Importanti

1. Integrazione: Le API consentono a diversi sistemi e applicazioni di lavorare insieme senza problemi.
2. Flessibilità: Permettono agli sviluppatori di accedere a specifiche funzionalità di altre applicazioni senza bisogno di comprendere l’intero codice.
3. Efficienza: Le API possono ridurre il tempo di sviluppo fornendo funzionalità pre-costruite.
4. Scalabilità: Le API ben progettate possono gestire carichi crescenti e basi utenti in crescita.

Realizzare Chiamate API con Postman

Ora che comprendiamo i fondamenti dei servizi web e delle API, esploriamo come effettuare le chiamate API utilizzando Postman. Esamineremo due esempi per dimostrare diversi tipi di chiamate API. https://jsonplaceholder.typicode.com è un sito web per il test delle API. Ce ne sono molti altri online.

Metodo GET: Una richiesta per recuperare dati specifici da un server senza modificare alcuna risorsa, solitamente utilizzato per ottenere informazioni ed sicuro per chiamate ripetute.

Metodo POST: Una richiesta per inviare dati da elaborare e memorizzare dal server, utilizzata spesso per la creazione di nuove risorse o l’invio di dati di moduli, che possono modificare lo stato del server.

Esempio 1: Realizzare una Richiesta GET

Iniziamo con una semplice richiesta GET per recuperare dati da un’API pubblica.

1. Aprire Postman e creare una nuova richiesta.
2. Impostare il metodo HTTP su GET.
3. Inserire il seguente URL: https://jsonplaceholder.typicode.com/posts/1
4. Cliccare sul pulsante “Send”.

Dovrebbe ricevere una risposta simile a questa:

{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

Questo esempio dimostra quanto sia facile recuperare dati da un’API utilizzando Postman. La risposta contiene un oggetto JSON con informazioni su un determinato post.

Esempio 2: Realizzare una Richiesta POST

Ora, creiamo una nuova risorsa utilizzando una richiesta POST.

1. Creare una nuova richiesta in Postman.

2. Impostare il metodo HTTP su POST.

3. Inserire l’URL: https://jsonplaceholder.typicode.com/posts

4. Andare alla scheda “Body”, selezionare “raw” e scegliere “JSON” dal menu a discesa.

5. Inserire il seguente JSON nel corpo:

jsonCopy{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1
}

Cliccare sul pulsante “Send”.

Dovrebbe ricevere una risposta simile a questa:

jsonCopy{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1,
  "id": 101
}

Questo esempio mostra come creare una nuova risorsa utilizzando una richiesta POST. L’API risponde con l’oggetto creato, compreso un nuovo id assegnato dal server.

Se il server utilizza HTTPS e ha un certificato autofirmato, potrebbe essere necessario disattivare la verifica del certificato SSL nelle impostazioni di Postman.

Funzioni Avanzate di Postman per Chiamate API

Postman offre diverse funzioni avanzate che possono migliorare le sue operazioni di test e sviluppo API:

Variabili d’Ambiente

Postman le consente di creare variabili d’ambiente per memorizzare e riutilizzare valori tra diverse richieste. Questo è particolarmente utile per gestire diversi endpoint API o token di autenticazione.

Per utilizzare le variabili d’ambiente:

1. Creare un nuovo ambiente in Postman.
2. Aggiungere variabili come base_url o api_key.
3. Utilizzare queste variabili nelle sue richieste con doppie parentesi graffe, ad esempio, {{base_url}}/api/endpoint.

Script Pre-richiesta

Può scrivere codice JavaScript che verrà eseguito prima dell’invio di una richiesta. Questo è utile per generare dati dinamici o configurare l’autenticazione.

Esempio di script pre-richiesta per generare un timestamp:

pm.environment.set(“timestamp”, new Date().getTime());

Test

Postman le consente di scrivere test per le sue chiamate API utilizzando JavaScript. Questi test possono convalidare i dati di risposta, controllare i codici di stato o effettuare altre verifiche.

Script di esempio per test nella sezione Tests di una nuova richiesta GET a https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}}:

// Analizza l'URL per estrarre il timestamp
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Registra il timestamp
console.log("Timestamp utilizzato:", timestamp);
// Aggiungi il timestamp alla risposta per visibilità
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Imposta la risposta modificata per visualizzarla in Postman
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Test per assicurarsi che il timestamp sia stato inviato
pm.test("Richiesta inviata con timestamp", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Controllare la scheda “Test Results” per vedere se il test è passato. Verificare anche la scheda “Console” per vedere il timestamp registrato. Il corpo della risposta ora includerà il valore del timestamp.

Migliori Pratiche per Realizzare Chiamate API con Postman

1. Organizzare le Sue Richieste: Utilizzare le raccolte e le cartelle per raggruppare le richieste correlate.
2. Utilizzare il Version Control: Postman le consente di esportare le raccolte. Memorizzarle in sistemi di version control come Git.
3. Documentare le Sue API: Utilizzare la funzione di documentazione di Postman per creare documentazione API chiara e interattiva.
4. Automatizzare i Test: Utilizzare il Collection Runner di Postman e il Newman CLI per automatizzare i suoi test API.
5. Gestire Correttamente l’Autenticazione: Utilizzare le variabili d’ambiente per memorizzare informazioni sensibili come chiavi API o token.
6. Monitorare le Prestazioni delle API: Configurare i monitor in Postman per tracciare le prestazioni e il tempo di attività delle API.

Conclusione

Il padroneggiamento delle chiamate API di Postman è una competenza essenziale per gli sviluppatori e i tester moderni. Comprendendo i servizi web, le API e l’RPC, può sfruttare le potenti funzionalità di Postman per ottimizzare i suoi processi di sviluppo e test delle API.

Abbiamo trattato i fondamenti delle chiamate API, esplorato le funzionalità avanzate di Postman e discusso le migliori pratiche. Con queste conoscenze, è ben equipaggiato per affrontare interazioni complesse con le API e costruire applicazioni robuste e interconnesse.

Ricordi, la chiave per diventare esperti nelle chiamate API di Postman è la pratica. Sperimentare diversi tipi di richieste, esplorare API pubbliche e sfidarsi a creare suite di test complete per le proprie API.

Mentre continua il suo viaggio nello sviluppo e nel test delle API, consideri di esplorare argomenti più avanzati come la sicurezza delle API, l’ottimizzazione delle prestazioni e i test di integrazione. Il mondo dei servizi web è vasto e in continua evoluzione, offrendo infinite opportunità di apprendimento e crescita.