Guida alla creazione e al test di API REST con JSON-Server

In questa guida, Guida alla creazione e al test di API REST con JSON-Server, vedremo come creare Api Rest con Json-server e come testare il nostro servizio WEB con i metodi CRUD

Indice dei contenuti

Introduzione

Nel moderno sviluppo web, è fondamentale poter testare rapidamente le API REST senza la complessità di un backend completo. JSON Server è uno strumento ideale per creare server leggeri, permettendo operazioni CRUD veloci. Funziona tramite Node.js, un ambiente di runtime JavaScript che consente di eseguire codice fuori dal browser, gestire file, database e server HTTP. Node.js include npm (Node Package Manager), utile per installare strumenti come json-server.

Installazione di Node.js

Scaricare Node.js dal sito ufficiale: https://nodejs.org/en.

Avviare l’installer e selezionare l’opzione per installare anche gli strumenti aggiuntivi.

Completata l’installazione eseguire i seguenti due comandi (bash) per verificare la corretta installazione di Node.js e nmp:

node -v

npm -v

node -v

npm -v

Se tutto è andato a buon fine l’output di ogni comando restituirà la versione installata

Se i comandi restituiscono le versioni installate, Node.js e npm sono pronti all’uso.

Creazione del progetto JSON Server

1. Inizializzare la cartella di progetto

Creare una cartella, ad esempio REST_API, e aprirla con Visual Studio Code:

 code .

 code .

Nel terminale di VS Code eseguire:

npm init -y

npm init -y

Questo comando crea il file package.json, necessario per gestire le dipendenze.

2. Installare JSON Server

Installazione globale (utile se si vuole riutilizzare JSON Server in altri progetti):

npm install -g json-server  # Installazione globale (opzionale)

npm install -g json-server  # Installazione globale (opzionale)

Creazione della REST API

1. Creare il file db.json

Nella cartella di progetto, creare un file db.json con dati iniziali:

{
  "users": [
    { "id": 1, "name": "Mario Rossi", "email": "mario@example.com" },
    { "id": 2, "name": "Luca Bianchi", "email": "luca@example.com" }
  ]
}

{
  "users": [
    { "id": 1, "name": "Mario Rossi", "email": "mario@example.com" },
    { "id": 2, "name": "Luca Bianchi", "email": "luca@example.com" }
  ]
}

2. Avvio del server

Eseguire il comando:

json-server --watch db.json --port 3000

json-server --watch db.json --port 3000

Aprendo http://localhost:3000 nel browser si vedrà la home del server; l’endpoint http://localhost:3000/users restituisce la lista utenti.

Test dei metodi CRUD

Test dei Metodi CRUD con Postman o Thunder Client

Le operazioni CRUD possono essere testate tramite Thunder Client (estensione di VS Code) o Postman. Ecco gli esempi principali:

1. Lettura (GET)

• Endpoint: GET http://localhost:3000/users
• Risultato atteso: lista utenti presenti nel database.

2. Creazione (POST)

Endpoint: POST http://localhost:3000/users

Body JSON:

{
  "id": 3,
  "name": "Giulia Verdi",
  "email": "giulia@example.com"
}

{
  "id": 3,
  "name": "Giulia Verdi",
  "email": "giulia@example.com"
}

Inviare la richiesta e verificare con GET che il nuovo utente sia stato aggiunto.

3. Aggiornamento (PUT)

• Endpoint: PUT http://localhost:3000/users/3
• Body JSON:

{
  "id": 3,
  "name": "Giuseppe Verdi",
  "email": "giulia@example.com"
}

{
  "id": 3,
  "name": "Giuseppe Verdi",
  "email": "giulia@example.com"
}

Il metodo PUT sostituisce completamente il record indicato.

4. Eliminazione (DELETE)

• Endpoint: DELETE http://localhost:3000/users/3

Dopo l’esecuzione, la richiesta GET non restituirà più l’utente con id 3.

Suggerimenti per lo sviluppo

• Usare XLS o Postman Collections per testare rapidamente più endpoint.
• Per progetti complessi, è possibile creare più file JSON collegati tra loro con relazioni tra entità.
• JSON Server è ideale per prototipi e test rapidi, ma non sostituisce un backend reale in produzione.

Conclusione

JSON Server permette di creare un backend completo e funzionale in pochi minuti, ideale per studenti e sviluppatori che vogliono testare API REST senza installare database complessi. Combinato con Node.js, consente di eseguire e condividere rapidamente progetti, verificare operazioni CRUD e sperimentare con strumenti come Postman o Thunder Client.

Grazie alla sua semplicità e leggerezza, JSON Server è uno strumento prezioso per chi studia sviluppo web e vuole comprendere i principi delle API REST in modo pratico e immediato.