Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Apprendre Implémentation de la Route "CREATE POST" | Développement d'API REST
Développement Backend Avec Node.js et Express.js
course content

Contenu du cours

Développement Backend Avec Node.js et Express.js

Développement Backend Avec Node.js et Express.js

1. Introduction
2. Applications Console
3. Cadre Express.js
4. Développement d'API REST

book
Implémentation de la Route "CREATE POST"

Nous allons examiner la création d'un nouveau post en utilisant la route "CREATE POST" dans le fichier postsRoutes.js. Cette route est responsable de la gestion de la création d'un post et de son enregistrement dans la source de données (database/posts.json).

Définition de la Route

Le code ci-dessous définit la route "CREATE POST" en utilisant router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Cette route est configurée pour gérer les requêtes HTTP POST vers le chemin racine /;
  • Elle utilise le middleware validatePostData, qui garantit que les données envoyées dans le corps de la requête sont valides avant de continuer.

Middleware de Validation des Données

Avant de plonger dans la logique de la route, nous devons créer un middleware de validation des données. Ce middleware garantit que les données envoyées dans le corps de la requête sont valides avant de tenter de créer un nouveau post.

// Middleware to validate post data
function validatePostData(req, res, next) {
  const { username, postTitle, postContent } = req.body;

  if (!username || !postTitle || !postContent) {
    return res.status(400).json({ error: "Missing required fields" });
  }

  // If data is valid, proceed to the next route handler
  next();
}
  • La fonction validatePostData extrait username, postTitle, et postContent du corps de la requête;
  • Elle vérifie si ces champs sont présents. Si l'un d'eux manque (!username, !postTitle, ou !postContent), elle répond avec un code de statut 400 (Bad Request) et un message d'erreur indiquant les champs requis manquants;
  • Si les données sont valides, le middleware appelle next(), permettant à la requête de continuer vers le gestionnaire de route (la route "CREATE POST" dans ce cas).

Avec le middleware de validation des données en place, continuons avec la logique de la route "CREATE POST".

Données du Nouveau Post

Pour créer un nouveau post, nous générons un ID unique en utilisant Date.now().toString(). De plus, nous extrayons username, postTitle, et postContent du corps de la requête.

const newPost = {
  id: Date.now().toString(),
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};

Ajouter le Nouveau Post à la Base de Données

Les étapes suivantes détaillent comment le nouveau post est ajouté à la base de données :

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Les données existantes sont lues à partir du fichier JSON en utilisant la fonction asynchrone readData, comme expliqué précédemment;
  • Le nouveau post est ajouté au tableau data;
  • Le tableau data mis à jour est ensuite réécrit dans le fichier JSON pour enregistrer le post nouvellement créé.

Envoi d'une Réponse

Après la création réussie du nouveau post, une réponse de succès est envoyée au client. La réponse inclut un code de statut de 201 (Créé) et les détails du post nouvellement créé au format JSON.

res.status(201).json(newPost);

Gestion des Erreurs

Nous enveloppons le code de la route dans un bloc try-catch pour 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);
  }
});

// CREATE POST
router.post("/", validatePostData, async (req, res, next) => {
  try {
    // Generate a unique ID for the new post
    const newPost = {
      id: Date.now().toString(),
      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);
  }
});

Code complet du fichier validateData.js

// Middleware to validate post data
function validatePostData(req, res, next) {
  const { username, postTitle, postContent } = req.body;

  if (!username || !postTitle || !postContent) {
    return res.status(400).json({ error: "Missing required fields" });
  }

  // If data is valid, proceed to the next route handler
  next();
}

module.exports = validatePostData;

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 4. Chapitre 7

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

course content

Contenu du cours

Développement Backend Avec Node.js et Express.js

Développement Backend Avec Node.js et Express.js

1. Introduction
2. Applications Console
3. Cadre Express.js
4. Développement d'API REST

book
Implémentation de la Route "CREATE POST"

Nous allons examiner la création d'un nouveau post en utilisant la route "CREATE POST" dans le fichier postsRoutes.js. Cette route est responsable de la gestion de la création d'un post et de son enregistrement dans la source de données (database/posts.json).

Définition de la Route

Le code ci-dessous définit la route "CREATE POST" en utilisant router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Cette route est configurée pour gérer les requêtes HTTP POST vers le chemin racine /;
  • Elle utilise le middleware validatePostData, qui garantit que les données envoyées dans le corps de la requête sont valides avant de continuer.

Middleware de Validation des Données

Avant de plonger dans la logique de la route, nous devons créer un middleware de validation des données. Ce middleware garantit que les données envoyées dans le corps de la requête sont valides avant de tenter de créer un nouveau post.

// Middleware to validate post data
function validatePostData(req, res, next) {
  const { username, postTitle, postContent } = req.body;

  if (!username || !postTitle || !postContent) {
    return res.status(400).json({ error: "Missing required fields" });
  }

  // If data is valid, proceed to the next route handler
  next();
}
  • La fonction validatePostData extrait username, postTitle, et postContent du corps de la requête;
  • Elle vérifie si ces champs sont présents. Si l'un d'eux manque (!username, !postTitle, ou !postContent), elle répond avec un code de statut 400 (Bad Request) et un message d'erreur indiquant les champs requis manquants;
  • Si les données sont valides, le middleware appelle next(), permettant à la requête de continuer vers le gestionnaire de route (la route "CREATE POST" dans ce cas).

Avec le middleware de validation des données en place, continuons avec la logique de la route "CREATE POST".

Données du Nouveau Post

Pour créer un nouveau post, nous générons un ID unique en utilisant Date.now().toString(). De plus, nous extrayons username, postTitle, et postContent du corps de la requête.

const newPost = {
  id: Date.now().toString(),
  username: req.body.username,
  postTitle: req.body.postTitle,
  postContent: req.body.postContent,
};

Ajouter le Nouveau Post à la Base de Données

Les étapes suivantes détaillent comment le nouveau post est ajouté à la base de données :

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Les données existantes sont lues à partir du fichier JSON en utilisant la fonction asynchrone readData, comme expliqué précédemment;
  • Le nouveau post est ajouté au tableau data;
  • Le tableau data mis à jour est ensuite réécrit dans le fichier JSON pour enregistrer le post nouvellement créé.

Envoi d'une Réponse

Après la création réussie du nouveau post, une réponse de succès est envoyée au client. La réponse inclut un code de statut de 201 (Créé) et les détails du post nouvellement créé au format JSON.

res.status(201).json(newPost);

Gestion des Erreurs

Nous enveloppons le code de la route dans un bloc try-catch pour 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);
  }
});

// CREATE POST
router.post("/", validatePostData, async (req, res, next) => {
  try {
    // Generate a unique ID for the new post
    const newPost = {
      id: Date.now().toString(),
      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);
  }
});

Code complet du fichier validateData.js

// Middleware to validate post data
function validatePostData(req, res, next) {
  const { username, postTitle, postContent } = req.body;

  if (!username || !postTitle || !postContent) {
    return res.status(400).json({ error: "Missing required fields" });
  }

  // If data is valid, proceed to the next route handler
  next();
}

module.exports = validatePostData;

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 4. Chapitre 7
some-alt