Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Aprende Creación del Endpoint Update de Publicación por Id | Creación de API REST con Node.js y Express.js
Desarrollo Backend con Node.js y Express.js

bookCreación del Endpoint Update de Publicación por Id

Investigaremos cómo actualizar una publicación existente utilizando la ruta "UPDATE POST BY ID" dentro del archivo postsRoutes.js. Esta ruta gestiona la actualización de una publicación basada en su ID único.

Definición de la Ruta

El siguiente código define la ruta "UPDATE POST BY ID" utilizando router.put():

router.put("/post/:id", validatePostData, async (req, res, next) => { ... }
  • Esta ruta está configurada para manejar solicitudes HTTP PUT, específicamente para actualizar publicaciones;
  • Incluye un parámetro :id en la ruta para identificar la publicación que se va a actualizar;
  • Se añade el middleware validatePostData para asegurar la validación de los datos antes de continuar. La lógica del middleware validatePostData permanece igual que en el paso anterior.

Obtención de datos de la solicitud

En este apartado, se extraen los datos necesarios de la solicitud, incluyendo el ID de la publicación y el contenido actualizado de la publicación:

const postId = req.params.id;
const updatedData = {
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};
  • El ID de la publicación se extrae de los parámetros de la solicitud, lo que lo hace disponible para su posterior procesamiento. El parámetro :id de la URL de la ruta se captura utilizando req.params.id;
  • Los campos username, postTitle y postContent se extraen del cuerpo de la solicitud.

Actualización de la publicación en la base de datos

La actualización de una publicación existente implica varios pasos, que se describen a continuación:

const data = await readData();

const postIndex = data.findIndex((post) => post.id === postId);

if (postIndex === -1) {
  return res.status(404).json({ error: "Post not found" });
}

data[postIndex] = {
  ...data[postIndex],
  ...updatedData,
};

await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Se leen los datos existentes del archivo JSON utilizando la función asíncrona readData, como se explicó anteriormente;
  • La variable postIndex almacena el índice de la publicación que se va a actualizar en el arreglo data comparando los IDs de las publicaciones;
  • Si la publicación no se encuentra (es decir, postIndex === -1), se devuelve al cliente una respuesta 404 (No Encontrado) con un mensaje de error;
  • Para actualizar los datos de la publicación, se combinan los datos existentes de la publicación (...data[postIndex]) con los datos actualizados (...updatedData). Esto garantiza que solo se actualicen los campos especificados y se conserven los datos existentes;
  • Finalmente, el arreglo data actualizado se escribe nuevamente en el archivo JSON para guardar los cambios realizados en la publicación.

Envío de una respuesta

Tras la actualización exitosa de la publicación, se envía una respuesta JSON al cliente. La respuesta incluye un código de estado 200 (OK), que indica una actualización exitosa y los datos actualizados de la publicación.

res.status(200).json(data[postIndex]);

Manejo de errores

El código de la ruta se envuelve en un bloque try-catch para gestionar posibles errores durante la recuperación de datos o el procesamiento de la solicitud. Cualquier error que ocurra se registra en la consola para fines de depuración:

try {
  // ... (code for retrieving and processing data)
} catch (error) {
  console.error(error.message);
}

Código completo del archivo postsRoutes.js en este paso

const express = require("express");
const fs = require("fs/promises");
const validatePostData = require("../middlewares/validateData");

const router = express.Router();

// Function to read data from the JSON file
async function readData() {
  try {
    // Read the contents of the `posts.json` file
    const data = await fs.readFile("./database/posts.json");
    // Parse the JSON data into a JavaScript object
    return JSON.parse(data);
  } catch (error) {
    // If an error occurs during reading or parsing, throw the error
    throw error;
  }
}

// GET ALL POSTS
router.get("/", async (req, res, next) => {
  try {
    // Call the `readData` function to retrieve the list of posts
    const data = await readData();
    // Send the retrieved data as the response
    res.status(200).send(data);
  } catch (error) {
    // If an error occurs during data retrieval or sending the response
    console.error(error.message); // Log the error to the console for debugging
  }
});

// GET POST BY ID
router.get("/post/:id", async (req, res, next) => {
  try {
    // Extract the post ID from the request parameters
    const postId = req.params.id;
    // Read data from the JSON file
    const data = await readData();

    // Find the post with the matching ID
    const post = data.find((post) => post.id === postId);

    // If the post is not found, send a 404 response
    if (!post) {
      res.status(404).json({ error: "Post not found" });
    } else {
      // If the post is found, send it as the response
      res.status(200).send(post);
    }
  } catch (error) {
    // Handle errors by logging them and sending an error response
    console.error(error.message);
  }
});

// CREATE POST
router.post("/", validatePostData, async (req, res, next) => {
  try {
    const newPost = {
      id: Date.now().toString(), // Generate a unique ID for the new post
      username: req.body.username,
      postTitle: req.body.postTitle,
      postContent: req.body.postContent,
    };

    // Read the existing data
    const data = await readData();

    // Add the new post to the data
    data.push(newPost);

    // Write the updated data back to the JSON file
    await fs.writeFile("./database/posts.json", JSON.stringify(data));

    // Send a success response with the new post
    res.status(201).json(newPost);
  } catch (error) {
    // Handle errors by logging them to the console
    console.error(error.message);
  }
});

// UPDATE POST BY ID
router.put("/post/:id", validatePostData, async (req, res, next) => {
  try {
    // Extract the post ID from the request parameters
    const postId = req.params.id;
    // Extract the updated data from the request body
    const updatedData = {
      username: req.body.username,
      postTitle: req.body.postTitle,
      postContent: req.body.postContent,
    };

    // Read the existing data
    const data = await readData();

    // Find the index of the post with the specified ID in the data array
    const postIndex = data.findIndex((post) => post.id === postId);

    // If the post with the specified ID doesn't exist, return a 404 error
    if (postIndex === -1) {
      return res.status(404).json({ error: "Post not found" });
    }

    // Update the post data with the new data using spread syntax
    data[postIndex] = {
      ...data[postIndex], // Keep existing data
      ...updatedData, // Apply updated data
    };

    // Write the updated data back
    await fs.writeFile("./database/posts.json", JSON.stringify(data));

    // Send a success response with the updated post
    res.status(200).json(data[postIndex]);
  } catch (error) {
    console.error(error.message);
    next(error);
  }
});

¿Todo estuvo claro?

¿Cómo podemos mejorarlo?

¡Gracias por tus comentarios!

Sección 4. Capítulo 8

Pregunte a AI

expand

Pregunte a AI

ChatGPT

Pregunte lo que quiera o pruebe una de las preguntas sugeridas para comenzar nuestra charla

Awesome!

Completion rate improved to 2.56

bookCreación del Endpoint Update de Publicación por Id

Desliza para mostrar el menú

Investigaremos cómo actualizar una publicación existente utilizando la ruta "UPDATE POST BY ID" dentro del archivo postsRoutes.js. Esta ruta gestiona la actualización de una publicación basada en su ID único.

Definición de la Ruta

El siguiente código define la ruta "UPDATE POST BY ID" utilizando router.put():

router.put("/post/:id", validatePostData, async (req, res, next) => { ... }
  • Esta ruta está configurada para manejar solicitudes HTTP PUT, específicamente para actualizar publicaciones;
  • Incluye un parámetro :id en la ruta para identificar la publicación que se va a actualizar;
  • Se añade el middleware validatePostData para asegurar la validación de los datos antes de continuar. La lógica del middleware validatePostData permanece igual que en el paso anterior.

Obtención de datos de la solicitud

En este apartado, se extraen los datos necesarios de la solicitud, incluyendo el ID de la publicación y el contenido actualizado de la publicación:

const postId = req.params.id;
const updatedData = {
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};
  • El ID de la publicación se extrae de los parámetros de la solicitud, lo que lo hace disponible para su posterior procesamiento. El parámetro :id de la URL de la ruta se captura utilizando req.params.id;
  • Los campos username, postTitle y postContent se extraen del cuerpo de la solicitud.

Actualización de la publicación en la base de datos

La actualización de una publicación existente implica varios pasos, que se describen a continuación:

const data = await readData();

const postIndex = data.findIndex((post) => post.id === postId);

if (postIndex === -1) {
  return res.status(404).json({ error: "Post not found" });
}

data[postIndex] = {
  ...data[postIndex],
  ...updatedData,
};

await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Se leen los datos existentes del archivo JSON utilizando la función asíncrona readData, como se explicó anteriormente;
  • La variable postIndex almacena el índice de la publicación que se va a actualizar en el arreglo data comparando los IDs de las publicaciones;
  • Si la publicación no se encuentra (es decir, postIndex === -1), se devuelve al cliente una respuesta 404 (No Encontrado) con un mensaje de error;
  • Para actualizar los datos de la publicación, se combinan los datos existentes de la publicación (...data[postIndex]) con los datos actualizados (...updatedData). Esto garantiza que solo se actualicen los campos especificados y se conserven los datos existentes;
  • Finalmente, el arreglo data actualizado se escribe nuevamente en el archivo JSON para guardar los cambios realizados en la publicación.

Envío de una respuesta

Tras la actualización exitosa de la publicación, se envía una respuesta JSON al cliente. La respuesta incluye un código de estado 200 (OK), que indica una actualización exitosa y los datos actualizados de la publicación.

res.status(200).json(data[postIndex]);

Manejo de errores

El código de la ruta se envuelve en un bloque try-catch para gestionar posibles errores durante la recuperación de datos o el procesamiento de la solicitud. Cualquier error que ocurra se registra en la consola para fines de depuración:

try {
  // ... (code for retrieving and processing data)
} catch (error) {
  console.error(error.message);
}

Código completo del archivo postsRoutes.js en este paso

const express = require("express");
const fs = require("fs/promises");
const validatePostData = require("../middlewares/validateData");

const router = express.Router();

// Function to read data from the JSON file
async function readData() {
  try {
    // Read the contents of the `posts.json` file
    const data = await fs.readFile("./database/posts.json");
    // Parse the JSON data into a JavaScript object
    return JSON.parse(data);
  } catch (error) {
    // If an error occurs during reading or parsing, throw the error
    throw error;
  }
}

// GET ALL POSTS
router.get("/", async (req, res, next) => {
  try {
    // Call the `readData` function to retrieve the list of posts
    const data = await readData();
    // Send the retrieved data as the response
    res.status(200).send(data);
  } catch (error) {
    // If an error occurs during data retrieval or sending the response
    console.error(error.message); // Log the error to the console for debugging
  }
});

// GET POST BY ID
router.get("/post/:id", async (req, res, next) => {
  try {
    // Extract the post ID from the request parameters
    const postId = req.params.id;
    // Read data from the JSON file
    const data = await readData();

    // Find the post with the matching ID
    const post = data.find((post) => post.id === postId);

    // If the post is not found, send a 404 response
    if (!post) {
      res.status(404).json({ error: "Post not found" });
    } else {
      // If the post is found, send it as the response
      res.status(200).send(post);
    }
  } catch (error) {
    // Handle errors by logging them and sending an error response
    console.error(error.message);
  }
});

// CREATE POST
router.post("/", validatePostData, async (req, res, next) => {
  try {
    const newPost = {
      id: Date.now().toString(), // Generate a unique ID for the new post
      username: req.body.username,
      postTitle: req.body.postTitle,
      postContent: req.body.postContent,
    };

    // Read the existing data
    const data = await readData();

    // Add the new post to the data
    data.push(newPost);

    // Write the updated data back to the JSON file
    await fs.writeFile("./database/posts.json", JSON.stringify(data));

    // Send a success response with the new post
    res.status(201).json(newPost);
  } catch (error) {
    // Handle errors by logging them to the console
    console.error(error.message);
  }
});

// UPDATE POST BY ID
router.put("/post/:id", validatePostData, async (req, res, next) => {
  try {
    // Extract the post ID from the request parameters
    const postId = req.params.id;
    // Extract the updated data from the request body
    const updatedData = {
      username: req.body.username,
      postTitle: req.body.postTitle,
      postContent: req.body.postContent,
    };

    // Read the existing data
    const data = await readData();

    // Find the index of the post with the specified ID in the data array
    const postIndex = data.findIndex((post) => post.id === postId);

    // If the post with the specified ID doesn't exist, return a 404 error
    if (postIndex === -1) {
      return res.status(404).json({ error: "Post not found" });
    }

    // Update the post data with the new data using spread syntax
    data[postIndex] = {
      ...data[postIndex], // Keep existing data
      ...updatedData, // Apply updated data
    };

    // Write the updated data back
    await fs.writeFile("./database/posts.json", JSON.stringify(data));

    // Send a success response with the updated post
    res.status(200).json(data[postIndex]);
  } catch (error) {
    console.error(error.message);
    next(error);
  }
});

¿Todo estuvo claro?

¿Cómo podemos mejorarlo?

¡Gracias por tus comentarios!

Sección 4. Capítulo 8
some-alt