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 Post Create | 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 Post Create

Nous allons examiner la création d’un nouveau post en utilisant la route « CREATE POST » dans le fichier postsRoutes.js. Cette route est chargée de gérer la création d’un post et de l’enregistrer dans la source de données (database/posts.json).

Définition de la route

Le code ci-dessous définit la route « CREATE POST » à l’aide de router.post() :

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Cette route est configurée pour traiter 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 poursuivre.

Middleware de validation des données

Avant d'aborder la logique de la route, il est nécessaire de 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 les champs 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 d'état 400 (Bad Request) et un message d'erreur indiquant que des champs obligatoires sont manquants ;
  • Si les données sont valides, le middleware appelle next(), permettant à la requête de continuer vers le gestionnaire de route (dans ce cas, la route "CREATE POST").

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

Données du nouveau post

Pour créer un nouveau post, un identifiant unique est généré à l'aide de Date.now().toString(). De plus, les champs username, postTitle et postContent sont extraits 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 à l'aide de 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 afin d'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 201 (Créé) et les détails du post nouvellement créé au format JSON.

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

Gestion des erreurs

Nous encapsulons le code de la route 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. Toutes les erreurs survenant sont enregistrées 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

Awesome!

Completion rate improved to 2.56

bookCréation du Point de Terminaison Post Create

Glissez pour afficher le menu

Nous allons examiner la création d’un nouveau post en utilisant la route « CREATE POST » dans le fichier postsRoutes.js. Cette route est chargée de gérer la création d’un post et de l’enregistrer dans la source de données (database/posts.json).

Définition de la route

Le code ci-dessous définit la route « CREATE POST » à l’aide de router.post() :

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Cette route est configurée pour traiter 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 poursuivre.

Middleware de validation des données

Avant d'aborder la logique de la route, il est nécessaire de 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 les champs 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 d'état 400 (Bad Request) et un message d'erreur indiquant que des champs obligatoires sont manquants ;
  • Si les données sont valides, le middleware appelle next(), permettant à la requête de continuer vers le gestionnaire de route (dans ce cas, la route "CREATE POST").

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

Données du nouveau post

Pour créer un nouveau post, un identifiant unique est généré à l'aide de Date.now().toString(). De plus, les champs username, postTitle et postContent sont extraits 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 à l'aide de 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 afin d'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 201 (Créé) et les détails du post nouvellement créé au format JSON.

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

Gestion des erreurs

Nous encapsulons le code de la route 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. Toutes les erreurs survenant sont enregistrées 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