El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència
HOME Els meus cursos Finalitzats
◄ Anterior
◄

Gestió d'errors

Següent ►
►

La gestió d'errors és una part fonamental del desenvolupament d'APIs RESTful. Una API ben dissenyada ha de ser capaç de gestionar errors de manera eficient i proporcionar respostes clares i informatives als clients. En aquesta secció, explorarem els principis bàsics de la gestió d'errors, els codis d'estat HTTP més comuns per a errors, i com implementar una gestió d'errors robusta en una API RESTful.

Principis de la Gestió d'Errors

  1. Claredat i Consistència: Les respostes d'error han de ser clares i consistents. Això ajuda els desenvolupadors a comprendre què ha anat malament i com poden solucionar-ho.
  2. Informació Detallada: Proporciona informació suficient sobre l'error perquè el client pugui prendre mesures correctives. Això pot incloure missatges d'error descriptius, codis d'error específics, i detalls addicionals.
  3. Seguretat: No revelis informació sensible en els missatges d'error. Això pot incloure detalls sobre la configuració del servidor, la base de dades, o altres components interns.
  4. Codis d'Estat HTTP Apropiats: Utilitza els codis d'estat HTTP adequats per indicar el tipus d'error que s'ha produït.

Codis d'Estat HTTP per a Errors

Els codis d'estat HTTP són una part essencial de la comunicació d'errors en una API RESTful. A continuació, es presenten alguns dels codis d'estat més comuns per a errors:

Codi Significat Descripció
400 Bad Request La sol·licitud no es pot processar a causa d'un error del client.
401 Unauthorized La sol·licitud requereix autenticació.
403 Forbidden El servidor ha entès la sol·licitud, però es nega a autoritzar-la.
404 Not Found El recurs sol·licitat no s'ha trobat.
405 Method Not Allowed El mètode HTTP utilitzat no està permès per al recurs sol·licitat.
409 Conflict Hi ha un conflicte amb l'estat actual del recurs.
500 Internal Server Error S'ha produït un error intern al servidor.
503 Service Unavailable El servidor no està disponible actualment (per exemple, per manteniment).

Implementació de la Gestió d'Errors

Exemples de Codi

A continuació, es mostra un exemple de com implementar la gestió d'errors en una API RESTful utilitzant Node.js i Express:

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

// Middleware per gestionar errors
app.use((err, req, res, next) => {
  console.error(err.stack);
  const statusCode = err.statusCode || 500;
  const errorMessage = err.message || 'Internal Server Error';

  res.status(statusCode).json({
    error: {
      message: errorMessage,
      status: statusCode,
    },
  });
});

// Exemple de ruta que genera un error
app.get('/error', (req, res, next) => {
  const error = new Error('Aquesta és una prova d’error');
  error.statusCode = 400;
  next(error);
});

app.listen(3000, () => {
  console.log('Servidor escoltant al port 3000');
});

Explicació del Codi

  1. Middleware per a la Gestió d'Errors: El middleware de gestió d'errors s'encarrega de capturar qualsevol error que es produeixi en l'aplicació. Utilitza err.stack per registrar l'error i envia una resposta JSON amb el codi d'estat i el missatge d'error.
  2. Ruta d'Exemple: La ruta /error genera un error de prova amb un codi d'estat 400 (Bad Request). Aquest error és passat al middleware de gestió d'errors mitjançant next(error).

Exercici Pràctic

Exercici

Implementa una API RESTful que gestioni errors per a les següents situacions:

  1. Una sol·licitud a una ruta no existent ha de retornar un codi d'estat 404 (Not Found).
  2. Una sol·licitud sense autenticació ha de retornar un codi d'estat 401 (Unauthorized).
  3. Una sol·licitud amb un mètode HTTP no permès ha de retornar un codi d'estat 405 (Method Not Allowed).

Solució

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

// Middleware per gestionar errors
app.use((err, req, res, next) => {
  console.error(err.stack);
  const statusCode = err.statusCode || 500;
  const errorMessage = err.message || 'Internal Server Error';

  res.status(statusCode).json({
    error: {
      message: errorMessage,
      status: statusCode,
    },
  });
});

// Middleware per gestionar rutes no existents
app.use((req, res, next) => {
  const error = new Error('Not Found');
  error.statusCode = 404;
  next(error);
});

// Middleware per gestionar autenticació
app.use((req, res, next) => {
  const auth = req.headers.authorization;
  if (!auth) {
    const error = new Error('Unauthorized');
    error.statusCode = 401;
    next(error);
  } else {
    next();
  }
});

// Middleware per gestionar mètodes no permesos
app.use((req, res, next) => {
  const allowedMethods = ['GET', 'POST'];
  if (!allowedMethods.includes(req.method)) {
    const error = new Error('Method Not Allowed');
    error.statusCode = 405;
    next(error);
  } else {
    next();
  }
});

app.listen(3000, () => {
  console.log('Servidor escoltant al port 3000');
});

Explicació de la Solució

  1. Gestió de Rutes No Existents: El middleware per a rutes no existents crea un error amb codi d'estat 404 i el passa al middleware de gestió d'errors.
  2. Gestió d'Autenticació: El middleware d'autenticació comprova si hi ha un encapçalament d'autorització. Si no hi és, crea un error amb codi d'estat 401 i el passa al middleware de gestió d'errors.
  3. Gestió de Mètodes No Permesos: El middleware de mètodes no permesos comprova si el mètode HTTP utilitzat està permès. Si no ho està, crea un error amb codi d'estat 405 i el passa al middleware de gestió d'errors.

Conclusió

La gestió d'errors és crucial per a la robustesa i la usabilitat d'una API RESTful. Utilitzant codis d'estat HTTP adequats i proporcionant respostes d'error clares i informatives, pots ajudar els desenvolupadors a comprendre i solucionar problemes de manera eficient. A més, implementar una gestió d'errors robusta millora la seguretat i la fiabilitat de la teva API.

◄ Anterior
◄
Següent ►
►
El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència
© Copyright 2024. Tots els drets reservats