10.5. Creación de una API REST básica con NodeJS y ExpressJS: creación de los controladores

Uno de los elementos más importantes en la creación de una API REST básica con NodeJS y ExpressJS es la creación de los controladores. Los controladores son responsables de gestionar las solicitudes y respuestas del servidor, facilitando la comunicación entre el cliente y el servidor.

1. Iniciando el proyecto

Para comenzar, necesita instalar NodeJS y ExpressJS en su sistema. Puedes hacer esto usando el administrador de paquetes npm. En la terminal, escriba los siguientes comandos:

inicio npm -y
npm instalar express --guardar

Esto inicializará un nuevo proyecto NodeJS e instalará ExpressJS.

2. Creando el servidor

Con ExpressJS instalado, puede crear un servidor básico. Cree un nuevo archivo llamado 'server.js' y agregue el siguiente código:

const expresar = requerir('expresar');
aplicación constante = expresar();
puerto constante = 3000;

aplicación.listen(puerto, () => {
  console.log(`Servidor ejecutándose en http://localhost:${port}`);
});

Este código crea un nuevo servidor ExpressJS que escucha en el puerto 3000.

3. Creando los controladores

Ahora, creemos los controladores. En una API REST, los controladores son funciones que manejan solicitudes HTTP y envían una respuesta. Creemos un controlador para cada operación CRUD (Crear, Leer, Actualizar, Eliminar).

Cree un nuevo directorio llamado 'controladores' y dentro de él cree un archivo llamado 'userController.js'. En este archivo, agregue el siguiente código:

exports.getAllUsers = (req, res) => {
  res.status(200).json({
    estado: 'éxito',
    fecha: {
      usuarios: []
    }
  });
};

exports.createUser = (req, res) => {
  res.status(201).json({
    estado: 'éxito',
    fecha: {
      usuario: {}
    }
  });
};

exports.getUser = (req, res) => {
  res.status(200).json({
    estado: 'éxito',
    fecha: {
      usuario: {}
    }
  });
};

exports.updateUser = (req, res) => {
  res.status(200).json({
    estado: 'éxito',
    fecha: {
      usuario: {}
    }
  });
};

exports.deleteUser = (req, res) => {
  res.status(204).json({
    estado: 'éxito',
    fecha: nula
  });
};

Estos son los controladores básicos para las operaciones CRUD. No están haciendo mucho en este momento, pero puedes expandirlos para interactuar con una base de datos u otra fuente de datos.

4. Configurando las rutas

Con los controladores creados, es necesario configurar las rutas. Las rutas son las URL que los clientes utilizan para acceder a las funciones del controlador.

Cree un nuevo directorio llamado 'rutas' y dentro de él cree un archivo llamado 'userRoutes.js'. En este archivo, agregue el siguiente código:

const expresar = requerir('expresar');
const userController = require('../controllers/userController');
enrutador constante = express.Router();

enrutador.ruta('/')
  .get(userController.getAllUsers)
  .post(userController.createUser);

enrutador.ruta('/:id')
  .get(usuarioController.getUsuario)
  .patch(usuarioController.updateUser)
  .delete(userController.deleteUser);

módulo.exportaciones = enrutador;

Este código crea las rutas a las funciones del controlador. Ahora, si inicia el servidor y va a 'http://localhost:3000/', puede usar operaciones CRUD en la API.

En resumen, crear una API REST básica con NodeJS y ExpressJS implica crear un servidor, definir controladores para manejar solicitudes y respuestas, y configurar rutas para que los clientes puedan acceder a las funciones del controlador. Con estos componentes básicos, puede crear una API REST potente y flexible.

Siguiente página del libro electrónico gratuito:

71Creación de una API REST básica con NodeJS y ExpressJS: implementación de los métodos HTTP

4 minutos