Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Oppiskele Päivitä Postaus Tunnisteen Perusteella -Päätepisteen Rakentaminen | REST-rajapintojen Rakentaminen Node.js:llä ja Express.js:llä
Backend-kehitys Node.js:llä ja Express.js:llä

bookPäivitä Postaus Tunnisteen Perusteella -Päätepisteen Rakentaminen

Tässä osiossa tarkastellaan, kuinka olemassa oleva julkaisu päivitetään käyttämällä "UPDATE POST BY ID" -reittiä tiedostossa postsRoutes.js. Tämä reitti käsittelee julkaisun päivittämisen sen yksilöllisen tunnisteen perusteella.

Reitin määrittely

Alla oleva koodi määrittelee "UPDATE POST BY ID" -reitin käyttäen router.put():

router.put("/post/:id", validatePostData, async (req, res, next) => { ... }
  • Tämä reitti on määritelty käsittelemään HTTP PUT -pyyntöjä, erityisesti julkaisujen päivittämistä varten;
  • Reitin polussa on parametrisoitu :id, jonka avulla tunnistetaan päivitettävä julkaisu;
  • validatePostData-välimuisti lisätään varmistamaan tietojen validointi ennen jatkamista. validatePostData-välimuistin logiikka pysyy samana kuin edellisessä vaiheessa.

Datan hakeminen pyynnöstä

Tässä vaiheessa tarvittava data haetaan pyynnöstä, mukaan lukien postauksen ID ja päivitetty sisältö:

const postId = req.params.id;
const updatedData = {
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};
  • Postauksen ID haetaan pyynnön parametreista, jolloin se on käytettävissä jatkokäsittelyyn. Reitin URL:n :id-parametri saadaan käyttöön req.params.id avulla;
  • username, postTitle ja postContent haetaan pyynnön rungosta.

Postauksen päivittäminen tietokantaan

Olemassa olevan postauksen päivittäminen sisältää useita vaiheita, jotka on esitetty alla:

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));
  • Olemassa oleva data luetaan JSON-tiedostosta asynkronisen readData-funktion avulla, kuten aiemmin selitettiin;
  • postIndex-muuttujaan tallennetaan päivitettävän postauksen indeksi data-taulukossa vertaamalla postauksen ID:tä;
  • Jos postausta ei löydy (eli postIndex === -1), asiakkaalle palautetaan 404 (Not Found) -vastaus ja virheilmoitus;
  • Postauksen päivittämiseksi yhdistetään olemassa oleva postausdata (...data[postIndex]) ja päivitetty data (...updatedData). Tämä varmistaa, että vain määritellyt kentät päivittyvät ja muu data säilyy;
  • Lopuksi päivitetty data-taulukko kirjoitetaan takaisin JSON-tiedostoon, jolloin muutokset tallentuvat.

Vastauksen lähettäminen

Onnistuneen postauksen päivityksen jälkeen asiakkaalle lähetetään JSON-muotoinen vastaus. Vastaus sisältää tilakoodin 200 (OK), joka ilmaisee onnistuneen päivityksen, sekä päivitetyn postauksen tiedot.

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

Virheenkäsittely

Reittikoodin ympärille asetetaan try-catch-lohko mahdollisten virheiden käsittelemiseksi tietojen haun tai pyynnön käsittelyn aikana. Kaikki esiintyvät virheet kirjataan konsoliin vianmääritystä varten:

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

postsRoutes.js-tiedoston täydellinen koodi tässä vaiheessa

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);
  }
});

Oliko kaikki selvää?

Miten voimme parantaa sitä?

Kiitos palautteestasi!

Osio 4. Luku 8

Kysy tekoälyä

expand

Kysy tekoälyä

ChatGPT

Kysy mitä tahansa tai kokeile jotakin ehdotetuista kysymyksistä aloittaaksesi keskustelumme

Awesome!

Completion rate improved to 2.56

bookPäivitä Postaus Tunnisteen Perusteella -Päätepisteen Rakentaminen

Pyyhkäise näyttääksesi valikon

Tässä osiossa tarkastellaan, kuinka olemassa oleva julkaisu päivitetään käyttämällä "UPDATE POST BY ID" -reittiä tiedostossa postsRoutes.js. Tämä reitti käsittelee julkaisun päivittämisen sen yksilöllisen tunnisteen perusteella.

Reitin määrittely

Alla oleva koodi määrittelee "UPDATE POST BY ID" -reitin käyttäen router.put():

router.put("/post/:id", validatePostData, async (req, res, next) => { ... }
  • Tämä reitti on määritelty käsittelemään HTTP PUT -pyyntöjä, erityisesti julkaisujen päivittämistä varten;
  • Reitin polussa on parametrisoitu :id, jonka avulla tunnistetaan päivitettävä julkaisu;
  • validatePostData-välimuisti lisätään varmistamaan tietojen validointi ennen jatkamista. validatePostData-välimuistin logiikka pysyy samana kuin edellisessä vaiheessa.

Datan hakeminen pyynnöstä

Tässä vaiheessa tarvittava data haetaan pyynnöstä, mukaan lukien postauksen ID ja päivitetty sisältö:

const postId = req.params.id;
const updatedData = {
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};
  • Postauksen ID haetaan pyynnön parametreista, jolloin se on käytettävissä jatkokäsittelyyn. Reitin URL:n :id-parametri saadaan käyttöön req.params.id avulla;
  • username, postTitle ja postContent haetaan pyynnön rungosta.

Postauksen päivittäminen tietokantaan

Olemassa olevan postauksen päivittäminen sisältää useita vaiheita, jotka on esitetty alla:

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));
  • Olemassa oleva data luetaan JSON-tiedostosta asynkronisen readData-funktion avulla, kuten aiemmin selitettiin;
  • postIndex-muuttujaan tallennetaan päivitettävän postauksen indeksi data-taulukossa vertaamalla postauksen ID:tä;
  • Jos postausta ei löydy (eli postIndex === -1), asiakkaalle palautetaan 404 (Not Found) -vastaus ja virheilmoitus;
  • Postauksen päivittämiseksi yhdistetään olemassa oleva postausdata (...data[postIndex]) ja päivitetty data (...updatedData). Tämä varmistaa, että vain määritellyt kentät päivittyvät ja muu data säilyy;
  • Lopuksi päivitetty data-taulukko kirjoitetaan takaisin JSON-tiedostoon, jolloin muutokset tallentuvat.

Vastauksen lähettäminen

Onnistuneen postauksen päivityksen jälkeen asiakkaalle lähetetään JSON-muotoinen vastaus. Vastaus sisältää tilakoodin 200 (OK), joka ilmaisee onnistuneen päivityksen, sekä päivitetyn postauksen tiedot.

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

Virheenkäsittely

Reittikoodin ympärille asetetaan try-catch-lohko mahdollisten virheiden käsittelemiseksi tietojen haun tai pyynnön käsittelyn aikana. Kaikki esiintyvät virheet kirjataan konsoliin vianmääritystä varten:

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

postsRoutes.js-tiedoston täydellinen koodi tässä vaiheessa

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);
  }
});

Oliko kaikki selvää?

Miten voimme parantaa sitä?

Kiitos palautteestasi!

Osio 4. Luku 8
some-alt