Introduzione
Le API, o "Application Programming Interface", permettono a un'applicazione di comunicare con un'altra, come un ponte che collega due mondi diversi. Una RESTful API è un tipo di API che segue delle regole ben precise chiamate REST (che sta per Representational State Transfer). Usando una RESTful API, un'applicazione può chiedere o inviare informazioni a un server tramite il browser o altri programmi, come accade quando un sito web carica i dati da un database. In questa guida ti mostrerò passo per passo come creare una RESTful API usando Node.js e Express.
Cos'è una RESTful API?
Una RESTful API è un tipo di interfaccia che permette a due applicazioni di comunicare attraverso il web. Funziona tramite URL (indirizzi web) e comandi chiamati metodi HTTP, come GET e POST, che indicano al server cosa fare. Ad esempio, un sito web può usare una API per ottenere una lista di prodotti o per inviare informazioni su un nuovo ordine a un server.
Cosa sono gli URL e come funzionano nelle API?
Gli URL sono gli indirizzi web che permettono di accedere alle risorse (come dati o servizi) di un server. Quando accedi a una API, utilizzi un URL per specificare quale informazione vuoi ottenere o inviare. Ad esempio:
- GET /api/products recupera la lista di prodotti dal server.
- POST /api/products invia informazioni per creare un nuovo prodotto.
I Metodi Principali delle API: GET, POST, PUT, DELETE
Le RESTful API utilizzano alcuni comandi standard, chiamati metodi HTTP, che indicano cosa fare con le informazioni. Vediamoli uno per uno, spiegando cosa fanno e come accedere a queste API tramite link.
1. Metodo GET
Il metodo GET è utilizzato per recuperare informazioni dal server. Immagina di voler leggere una pagina di un libro: il metodo GET fa proprio questo, legge i dati ma non li modifica. Per esempio, se vogliamo ottenere una lista di utenti dal server, possiamo usare questo link:
GET http://www.tuosito.com/api/users
In questo esempio, il link fa una richiesta al server per ottenere una lista di utenti. Se visiti questo URL con il browser o lo usi in un programma, il server risponderà con i dati (di solito in formato JSON) della lista di utenti.
2. Metodo POST
Il metodo POST è usato per inviare informazioni al server, solitamente per creare qualcosa di nuovo. Ad esempio, se volessimo aggiungere un nuovo utente a un database, useremmo il metodo POST. Questo non si può fare semplicemente aprendo un link nel browser, ma richiede un programma o uno strumento come Postman che permette di inviare dati insieme alla richiesta. Ecco un esempio di come funzionerebbe:
POST http://www.tuosito.com/api/users
Body: {
"name": "Mario",
"email": "[email protected]"
}
In questo caso, stiamo inviando al server le informazioni di un nuovo utente, che verrà salvato nel database. Il server risponderà confermando che l'utente è stato creato con successo.
3. Metodo PUT
Il metodo PUT serve per aggiornare informazioni esistenti nel server. Per esempio, se vuoi cambiare l'email di un utente già esistente, puoi usare PUT. Ecco come appare un esempio:
PUT http://www.tuosito.com/api/users/1
Body: {
"name": "Mario",
"email": "[email protected]"
}
In questo esempio, l'utente con l'ID 1 (Mario) avrà la sua email aggiornata nel database. Anche questa operazione richiede l'uso di strumenti come Postman.
4. Metodo DELETE
Il metodo DELETE è usato per eliminare informazioni dal server. Se un utente deve essere rimosso, si può inviare una richiesta DELETE per farlo. Ecco come appare:
DELETE http://www.tuosito.com/api/users/1
Questa richiesta elimina l'utente con ID 1 dal database. Il server confermerà che l'utente è stato eliminato con successo.
Creare una RESTful API con Node.js e Express
Ora che abbiamo capito cosa sono le API, vediamo come possiamo creare una RESTful API da zero utilizzando Node.js e Express. Express è un framework molto popolare che rende facile la creazione di server e API con Node.js. Segui i passaggi qui sotto per costruire la tua API.
1. Configurazione dell'Ambiente
Prima di iniziare a scrivere il codice, è necessario configurare l'ambiente di sviluppo. Assicurati di avere Node.js e npm installati. Puoi scaricarli dal sito ufficiale di Node.js. Una volta installati, crea una nuova cartella per il progetto, apri il terminale in quella cartella e segui questi passaggi:
1.1. Inizializzazione del Progetto
Per inizializzare il progetto Node.js e installare Express, esegui questi comandi:
npm init -y npm install express
2. Creare il Server con Express
Dopo aver installato Express, crea un file chiamato index.js e inserisci il seguente codice per avviare il server:
const express = require('express');
const app = express();
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Server in esecuzione sulla porta ${PORT}`);
});
Questo codice avvia un server sulla porta 3000 (o su una porta configurata tramite variabile di ambiente). Per avviarlo, esegui il comando:
node index.js
3. Aggiungere le Rotte RESTful
Ora aggiungiamo alcune rotte per la nostra API. Iniziamo con una semplice rotta GET per recuperare una lista di utenti:
Rotta GET
app.get('/api/users', (req, res) => {
res.json([{ id: 1, name: 'Mario' }, { id: 2, name: 'Luigi' }]);
});
Rotta POST
Aggiungiamo ora una rotta POST per creare un nuovo utente:
app.use(express.json());
app.post('/api/users', (req, res) => {
const newUser = req.body;
res.status(201).json(newUser);
});
Rotta PUT
Aggiungiamo una rotta PUT per aggiornare un utente:
app.put('/api/users/:id', (req, res) => {
const userId = req.params.id;
const updatedUser = req.body;
res.status(200).json({ id: userId, ...updatedUser });
});
Rotta DELETE
Infine, aggiungiamo una rotta DELETE per eliminare un utente:
app.delete('/api/users/:id', (req, res) => {
const userId = req.params.id;
res.status(200).json({ message: `Utente con ID ${userId} eliminato` });
});
4. Testare l'API
Per testare la tua API, puoi utilizzare strumenti come Postman o Insomnia. Questi strumenti ti permettono di inviare richieste HTTP (GET, POST, PUT, DELETE) alla tua API e vedere le risposte in tempo reale.
Conclusione
Abbiamo visto cos'è una RESTful API, quali sono i metodi HTTP principali (GET, POST, PUT, DELETE), e come crearne una utilizzando Node.js e Express. Con questa guida, puoi iniziare a sviluppare API per le tue applicazioni web o mobile, semplificando la gestione dei dati tra il client e il server.
