El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència

HOME

En aquest tema, aprendrem a configurar l'entorn de desenvolupament necessari per crear una API RESTful. La configuració adequada de l'entorn és crucial per garantir que el desenvolupament sigui eficient i que l'API funcioni correctament en diferents entorns (desenvolupament, proves, producció).

Requisits previs

Abans de començar, assegura't de tenir instal·lats els següents components:

Node.js: Un entorn d'execució per a JavaScript que ens permetrà crear el servidor de l'API.
NPM (Node Package Manager): Ve inclòs amb Node.js i ens permetrà gestionar les dependències del projecte.
Un editor de codi: Recomanem Visual Studio Code (VS Code) per la seva facilitat d'ús i les seves extensions útils.
Postman: Una eina per provar APIs.

Instal·lació de Node.js i NPM

Pas 1: Descarregar i instal·lar Node.js

Visita la pàgina oficial de Node.js nodejs.org i descarrega la versió recomanada per a la teva plataforma (Windows, macOS, Linux).

Pas 2: Verificar la instal·lació

Després d'instal·lar Node.js, obre una terminal i executa els següents comandaments per verificar que Node.js i NPM s'han instal·lat correctament:

node -v
npm -v

Hauries de veure les versions instal·lades de Node.js i NPM.

Creació del projecte

Pas 1: Crear una carpeta per al projecte

Crea una nova carpeta per al teu projecte i accedeix-hi des de la terminal:

mkdir my-rest-api
cd my-rest-api

Pas 2: Inicialitzar el projecte amb NPM

Inicialitza el projecte amb NPM per crear un fitxer package.json, que gestionarà les dependències del projecte:

npm init -y

El paràmetre -y accepta els valors per defecte per a totes les preguntes.

Pas 3: Instal·lar les dependències necessàries

Per a aquest curs, utilitzarem Express, un framework minimalista per a Node.js que facilita la creació de servidors HTTP. Instal·la Express amb el següent comandament:

npm install express

Configuració de l'editor de codi

Pas 1: Instal·lar Visual Studio Code

Descarrega i instal·la Visual Studio Code des de la pàgina oficial code.visualstudio.com.

Pas 2: Instal·lar extensions recomanades

Obre Visual Studio Code i instal·la les següents extensions per millorar la teva experiència de desenvolupament:

ESLint: Per assegurar-te que el teu codi segueix les millors pràctiques de JavaScript.
Prettier: Per formatar el codi de manera consistent.
REST Client: Per provar les teves APIs directament des de VS Code.

Creació del servidor bàsic

Pas 1: Crear el fitxer principal

Crea un fitxer anomenat index.js a la carpeta del projecte. Aquest serà el punt d'entrada del nostre servidor.

Pas 2: Escriure el codi del servidor bàsic

Afegeix el següent codi al fitxer index.js per crear un servidor bàsic amb Express:

const express = require('express');
const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send('Hola, món!');
});

app.listen(port, () => {
  console.log(`Servidor escoltant a http://localhost:${port}`);
});

Pas 3: Executar el servidor

Des de la terminal, executa el següent comandament per iniciar el servidor:

node index.js

Hauries de veure el missatge Servidor escoltant a http://localhost:3000 a la terminal. Obre un navegador i visita http://localhost:3000 per veure la resposta "Hola, món!".

Exercici pràctic

Objectiu

Configurar un entorn de desenvolupament i crear un servidor bàsic que respongui amb un missatge personalitzat.

Passos

Segueix els passos descrits anteriorment per configurar l'entorn de desenvolupament.
Modifica el codi del servidor bàsic per respondre amb el missatge "Benvingut a la meva API RESTful!" en lloc de "Hola, món!".

Solució

const express = require('express');
const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send('Benvingut a la meva API RESTful!');
});

app.listen(port, () => {
  console.log(`Servidor escoltant a http://localhost:${port}`);
});

Conclusió

En aquesta secció, hem après a configurar l'entorn de desenvolupament necessari per crear una API RESTful utilitzant Node.js i Express. Hem creat un servidor bàsic que respon a les peticions HTTP i hem provat la seva funcionalitat. Aquesta configuració ens servirà de base per als següents temes del curs.

Configuració de l'entorn de desenvolupament