API – Application Programming Interface – Prima Parte
Dicembre 11, 2023Un primo esempio semplice di utilizzo delle API WEB
Penso sia necessario introdurre uno schema semplice, intuitivo, al fine di comprendere il funzionamento di un API. Di seguito, il primo diagramma di sequenza in linguaggio UML.
(Diagramma di sequenza per descrivere l’utilizzo delle API Web).
Innanzitutto, descriviamo, quali sono gli “oggetti” che fanno parte del diagramma di sequenza mostrato nell’immagine precedente.
- Lo “User” rappresenta l’utente che esegue una richiesta all’API.
- Il “Client“, è l’applicazione che l’utente utilizza per interagire con l’API.
- L'”APIServer” rappresenta il server in cui è implementata l’API (potrebbe essere implementata in un server NodeJS con il framework Express) a cui il client invia la richiesta. Il server elabora la richiesta e restituisce una risposta.
- Il “Database” rappresenta un RDMBS (Relation Database Management System) che potrebbe essere utilizzato dal server dell’API per recuperare dati o memorizzare informazioni.
Ora, dopo aver definito gli “oggetti” del diagramma proviamo a descrivere passo per passo l’interazione tra i vari oggetti.
- Lo” User” inizia eseguendo con un azione ben specifica una richiesta all’API attraverso il suo client.
- Il “Client” invia la richiesta all’ “APIServer” tramite una chiamata HTTP o HTTPS.
- Il server dell’API (“APIServer“) riceve la richiesta e attiva il processo di gestione della richiesta.
- L’ “APIServer” potrebbe avere bisogno di accedere a un “Database” per ottenere o memorizzare dati correlati alla richiesta. In questo caso, comunica con il database.
- Il “Database” risponde con i dati richiesti all’ “APIServer“.
- L’ “APIServer” riceve la risposta dal database e la incorpora nella sua risposta HTTP o HTTPS.
- L’ “APIServer” invia la risposta HTTP o HTTPS al “Client“.
- Il “Client” riceve la risposta HTTP o HTTPS dal “APIServer” e la mostra all’utente.
Ora, che abbiamo capito come si svolge l’interazione tra i vari oggetti del diagramma di sequenza, cerchiamo di implementare un esempio concreto utilizzando un client in Python, un Server NodeJS e il Framework Express simulando la chiamata al “Database“.
“Purtroppo non si vive solo di teoria e qualche volta bisogna fare i conti con la pratica. E’ proprio per tale motivo che seguirà un esempio, più o meno riuscito!”
– Dr. LeeMega
