Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Apprendre Création du Point de Terminaison GET Post par Identifiant | Création d'API REST avec Node.js et Express.js
Développement Backend avec Node.js et Express.js

bookCréation du Point de Terminaison GET Post par Identifiant

Nous allons examiner la mise en œuvre de la route « GET POST BY ID » dans le fichier postsRoutes.js file. Cette route récupère et renvoie un post spécifique en fonction de son identifiant unique (id) fourni dans l’URL.

Remarque

Le terme « base de données » fait spécifiquement référence au fichier posts.json situé dans le dossier database.

Définition de la route

Le code ci-dessous définit la route « GET POST BY ID » à l'aide de router.get() :

router.get("/post/:id", async (req, res, next) => { ... }
  • Cette route est configurée pour traiter les requêtes HTTP GET ;
  • Le chemin de la route /post/:id inclut un paramètre :id, qui capture l'identifiant du post depuis l'URL.

Extraction de l'identifiant du post

L'identifiant du post est extrait à partir des paramètres de la requête en utilisant req.params.id :

const postId = req.params.id;

Cette ligne récupère la valeur :id depuis l'URL, la rendant disponible pour un traitement ultérieur.

Recherche du post dans la base de données

Ensuite, une recherche du post correspondant à l'identifiant est effectuée dans la base de données :

const data = await readData();

const post = data.find((post) => post.id === postId);
  • La fonction asynchrone readData est utilisée pour récupérer les données depuis le fichier JSON ;
  • La méthode find() permet de localiser un post dont l'identifiant correspond à celui recherché dans les données récupérées ;
  • La variable post contient le post trouvé ou undefined si aucun résultat ne correspond.

Gestion de la réponse

La réponse est gérée en fonction de la présence ou non d’un article :

if (!post) {
  res.status(404).json({ error: "Post not found" });
} else {
  res.status(200).send(post);
}
  • Si aucun article n’est trouvé (c’est-à-dire que post est undefined), une réponse 404 est envoyée avec un message d’erreur indiquant que l’article demandé est introuvable ;
  • Si un article est trouvé, il est envoyé dans la réponse avec un code de statut 200 (OK).

Gestion des erreurs

Le code de la route est encapsulé dans un bloc try-catch afin de gérer les erreurs potentielles lors de la récupération des données ou du traitement de la requête. Toute erreur survenant est enregistrée dans la console à des fins de débogage :

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

Code complet du fichier postsRoutes.js à cette étape

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

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 4. Chapitre 6

Demandez à l'IA

expand

Demandez à l'IA

ChatGPT

Posez n'importe quelle question ou essayez l'une des questions suggérées pour commencer notre discussion

Suggested prompts:

Can you explain how the readData function works in more detail?

What should I do if I get an error when trying to fetch a post by ID?

How can I test this GET POST BY ID route using a tool like Postman?

Awesome!

Completion rate improved to 2.56

bookCréation du Point de Terminaison GET Post par Identifiant

Glissez pour afficher le menu

Nous allons examiner la mise en œuvre de la route « GET POST BY ID » dans le fichier postsRoutes.js file. Cette route récupère et renvoie un post spécifique en fonction de son identifiant unique (id) fourni dans l’URL.

Remarque

Le terme « base de données » fait spécifiquement référence au fichier posts.json situé dans le dossier database.

Définition de la route

Le code ci-dessous définit la route « GET POST BY ID » à l'aide de router.get() :

router.get("/post/:id", async (req, res, next) => { ... }
  • Cette route est configurée pour traiter les requêtes HTTP GET ;
  • Le chemin de la route /post/:id inclut un paramètre :id, qui capture l'identifiant du post depuis l'URL.

Extraction de l'identifiant du post

L'identifiant du post est extrait à partir des paramètres de la requête en utilisant req.params.id :

const postId = req.params.id;

Cette ligne récupère la valeur :id depuis l'URL, la rendant disponible pour un traitement ultérieur.

Recherche du post dans la base de données

Ensuite, une recherche du post correspondant à l'identifiant est effectuée dans la base de données :

const data = await readData();

const post = data.find((post) => post.id === postId);
  • La fonction asynchrone readData est utilisée pour récupérer les données depuis le fichier JSON ;
  • La méthode find() permet de localiser un post dont l'identifiant correspond à celui recherché dans les données récupérées ;
  • La variable post contient le post trouvé ou undefined si aucun résultat ne correspond.

Gestion de la réponse

La réponse est gérée en fonction de la présence ou non d’un article :

if (!post) {
  res.status(404).json({ error: "Post not found" });
} else {
  res.status(200).send(post);
}
  • Si aucun article n’est trouvé (c’est-à-dire que post est undefined), une réponse 404 est envoyée avec un message d’erreur indiquant que l’article demandé est introuvable ;
  • Si un article est trouvé, il est envoyé dans la réponse avec un code de statut 200 (OK).

Gestion des erreurs

Le code de la route est encapsulé dans un bloc try-catch afin de gérer les erreurs potentielles lors de la récupération des données ou du traitement de la requête. Toute erreur survenant est enregistrée dans la console à des fins de débogage :

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

Code complet du fichier postsRoutes.js à cette étape

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

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 4. Chapitre 6
some-alt