Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Lernen Erstellung des Create-Post-Endpunkts | Erstellung von REST-APIs mit Node.js und Express.js
Backend-Entwicklung mit Node.js und Express.js

bookErstellung des Create-Post-Endpunkts

Wir betrachten das Erstellen eines neuen Beitrags über die "CREATE POST"-Route in der Datei postsRoutes.js. Diese Route ist dafür zuständig, einen Beitrag zu erstellen und in der Datenquelle (database/posts.json) zu speichern.

Routen-Definition

Der folgende Code definiert die "CREATE POST"-Route mit router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Diese Route ist für die Verarbeitung von HTTP-POST-Anfragen an den Root-Pfad / konfiguriert;
  • Sie verwendet die Middleware validatePostData, die sicherstellt, dass die im Request-Body gesendeten Daten vor der weiteren Verarbeitung gültig sind.

Datenvalidierungs-Middleware

Bevor auf die Logik der Route eingegangen wird, muss eine Middleware zur Datenvalidierung erstellt werden. Diese Middleware stellt sicher, dass die im Request-Body gesendeten Daten gültig sind, bevor versucht wird, einen neuen Beitrag zu erstellen.

// 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();
}
  • Die Funktion validatePostData extrahiert username, postTitle und postContent aus dem Request-Body;
  • Es wird überprüft, ob diese Felder vorhanden sind. Falls eines dieser Felder fehlt (!username, !postTitle oder !postContent), erfolgt eine Antwort mit dem Statuscode 400 (Bad Request) und einer Fehlermeldung, die auf fehlende Pflichtfelder hinweist;
  • Sind die Daten gültig, ruft die Middleware next() auf, sodass die Anfrage an den Routen-Handler weitergeleitet wird (in diesem Fall die "CREATE POST"-Route).

Mit der Datenvalidierungs-Middleware können wir nun mit der Logik der "CREATE POST"-Route fortfahren.

Neue Beitragsdaten

Um einen neuen Beitrag zu erstellen, wird eine eindeutige ID mit Date.now().toString() generiert. Zusätzlich werden username, postTitle und postContent aus dem Request-Body extrahiert.

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

Hinzufügen des neuen Beitrags zur Datenbank

Die folgenden Schritte beschreiben, wie der neue Beitrag zur Datenbank hinzugefügt wird:

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Die vorhandenen Daten werden mit der asynchronen Funktion readData aus der JSON-Datei gelesen, wie zuvor erläutert;
  • Der neue Beitrag wird dem Array data hinzugefügt;
  • Das aktualisierte Array data wird anschließend zurück in die JSON-Datei geschrieben, um den neu erstellten Beitrag zu speichern.

Senden einer Antwort

Nach erfolgreichem Erstellen des neuen Beitrags wird eine Erfolgsantwort an den Client gesendet. Die Antwort enthält den Statuscode 201 (Created) sowie die Details des neu erstellten Beitrags im JSON-Format.

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

Fehlerbehandlung

Der Routencode wird in einen try-catch-Block eingebettet, um potenzielle Fehler während der Datenabfrage oder der Anfrageverarbeitung abzufangen. Alle auftretenden Fehler werden zur Fehlersuche in der Konsole protokolliert:

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

Vollständiger Code der Datei postsRoutes.js in diesem Schritt

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

Vollständiger Code der Datei 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;

War alles klar?

Wie können wir es verbessern?

Danke für Ihr Feedback!

Abschnitt 4. Kapitel 7

Fragen Sie AI

expand

Fragen Sie AI

ChatGPT

Fragen Sie alles oder probieren Sie eine der vorgeschlagenen Fragen, um unser Gespräch zu beginnen

Awesome!

Completion rate improved to 2.56

bookErstellung des Create-Post-Endpunkts

Swipe um das Menü anzuzeigen

Wir betrachten das Erstellen eines neuen Beitrags über die "CREATE POST"-Route in der Datei postsRoutes.js. Diese Route ist dafür zuständig, einen Beitrag zu erstellen und in der Datenquelle (database/posts.json) zu speichern.

Routen-Definition

Der folgende Code definiert die "CREATE POST"-Route mit router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Diese Route ist für die Verarbeitung von HTTP-POST-Anfragen an den Root-Pfad / konfiguriert;
  • Sie verwendet die Middleware validatePostData, die sicherstellt, dass die im Request-Body gesendeten Daten vor der weiteren Verarbeitung gültig sind.

Datenvalidierungs-Middleware

Bevor auf die Logik der Route eingegangen wird, muss eine Middleware zur Datenvalidierung erstellt werden. Diese Middleware stellt sicher, dass die im Request-Body gesendeten Daten gültig sind, bevor versucht wird, einen neuen Beitrag zu erstellen.

// 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();
}
  • Die Funktion validatePostData extrahiert username, postTitle und postContent aus dem Request-Body;
  • Es wird überprüft, ob diese Felder vorhanden sind. Falls eines dieser Felder fehlt (!username, !postTitle oder !postContent), erfolgt eine Antwort mit dem Statuscode 400 (Bad Request) und einer Fehlermeldung, die auf fehlende Pflichtfelder hinweist;
  • Sind die Daten gültig, ruft die Middleware next() auf, sodass die Anfrage an den Routen-Handler weitergeleitet wird (in diesem Fall die "CREATE POST"-Route).

Mit der Datenvalidierungs-Middleware können wir nun mit der Logik der "CREATE POST"-Route fortfahren.

Neue Beitragsdaten

Um einen neuen Beitrag zu erstellen, wird eine eindeutige ID mit Date.now().toString() generiert. Zusätzlich werden username, postTitle und postContent aus dem Request-Body extrahiert.

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

Hinzufügen des neuen Beitrags zur Datenbank

Die folgenden Schritte beschreiben, wie der neue Beitrag zur Datenbank hinzugefügt wird:

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Die vorhandenen Daten werden mit der asynchronen Funktion readData aus der JSON-Datei gelesen, wie zuvor erläutert;
  • Der neue Beitrag wird dem Array data hinzugefügt;
  • Das aktualisierte Array data wird anschließend zurück in die JSON-Datei geschrieben, um den neu erstellten Beitrag zu speichern.

Senden einer Antwort

Nach erfolgreichem Erstellen des neuen Beitrags wird eine Erfolgsantwort an den Client gesendet. Die Antwort enthält den Statuscode 201 (Created) sowie die Details des neu erstellten Beitrags im JSON-Format.

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

Fehlerbehandlung

Der Routencode wird in einen try-catch-Block eingebettet, um potenzielle Fehler während der Datenabfrage oder der Anfrageverarbeitung abzufangen. Alle auftretenden Fehler werden zur Fehlersuche in der Konsole protokolliert:

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

Vollständiger Code der Datei postsRoutes.js in diesem Schritt

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

Vollständiger Code der Datei 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;

War alles klar?

Wie können wir es verbessern?

Danke für Ihr Feedback!

Abschnitt 4. Kapitel 7
some-alt