10.4. Creación de una API REST básica con NodeJS y ExpressJS: definición de rutas

Crear una API REST básica con NodeJS y ExpressJS es un proceso de varios pasos. Uno de los pasos más importantes es definir rutas, que permiten a los usuarios interactuar con su API de diferentes maneras. En este artículo, discutiremos cómo definir rutas en su API usando NodeJS y ExpressJS.

Para empezar, es importante entender qué es una ruta. En términos simples, una ruta es una ruta o URL a la que los usuarios pueden acceder para interactuar con su API. Por ejemplo, si tiene una API que administra una lista de tareas, puede tener rutas como '/tasks' para obtener todas las tareas, '/tasks/:id' para obtener una tarea específica, '/tasks' para crear una nueva. una tarea, y así sucesivamente.

Para definir rutas en tu API, necesitas ExpressJS, un framework para NodeJS que simplifica la creación de APIs. Para instalar ExpressJS, puedes usar npm (Node Package Manager), que es una herramienta que te permite instalar paquetes NodeJS . Puede instalar ExpressJS con el siguiente comando:

npm instalar expreso

Una vez instalado ExpressJS, puede comenzar a definir sus rutas. Para hacer esto, primero necesita crear una instancia de Express y luego usar los métodos proporcionados por esa instancia para definir sus rutas. Aquí tienes un ejemplo:

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

app.get('/tareas', (req, res) => {
  // Código para obtener todas las tareas
});

app.get('/tareas/:id', (req, res) => {
  // Código para obtener una tarea específica
});

app.post('/tareas', (req, res) => {
  // Código para crear una nueva tarea
});

aplicación.escuchar(3000, () => {
  console.log('API ejecutándose en el puerto 3000');
});

Como puede ver, Express proporciona métodos como 'obtener', 'publicar', 'poner' y 'eliminar' que corresponden a verbos HTTP que los usuarios pueden usar para interactuar con su API. Cada método acepta una URL (o ruta) y una función de devolución de llamada que se llamará cuando se acceda a la ruta.

La función de devolución de llamada toma dos argumentos: 'req' y 'res'. 'req' es un objeto que contiene información sobre la solicitud HTTP realizada por el usuario, como parámetros de URL, datos enviados en el cuerpo de la solicitud, encabezados de la solicitud, etc. 'res' es un objeto que puedes utilizar para enviar una respuesta al usuario.

Por ejemplo, si quisieras enviar una lista de tareas al usuario cuando accede a la ruta '/tareas', podrías hacer algo como esto:

app.get('/tareas', (req, res) => {
  tareas constantes = [
    { id: 1, nombre: 'compras' },
    { id: 2, nombre: 'Estudiar para el examen' },
    //...
  ];

  res.json(tareas);
});

En el ejemplo anterior, 'res.json' es un método que convierte la matriz 'tareas' en una cadena JSON y la envía al usuario como respuesta.

Definir rutas en su API es una parte crucial del proceso de creación de una API con NodeJS y ExpressJS. Con las rutas definidas, los usuarios pueden interactuar con su API de diversas formas, obteniendo datos, enviándolos, actualizándolos y eliminando datos. Al definir tus rutas, recuerda pensar detenidamente qué rutas necesitas y qué datos necesitas enviar y recibir en cada ruta.

Siguiente página del libro electrónico gratuito:

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

4 minutos