Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Lernen Implementierung der "Create Post"-Route | Entwicklung von REST-API
Backend-Entwicklung mit Node.js und Express.js
course content

Kursinhalt

Backend-Entwicklung mit Node.js und Express.js

Backend-Entwicklung mit Node.js und Express.js

1. Einführung
2. Konsolenanwendungen
3. Express.js Framework
4. Entwicklung von REST-API

book
Implementierung der "Create Post"-Route

Wir werden die Erstellung eines neuen Beitrags mit der Route "CREATE POST" innerhalb der Datei postsRoutes.js untersuchen. Diese Route ist dafür verantwortlich, die Erstellung eines Beitrags zu bearbeiten und ihn in der Datenquelle (database/posts.json) zu speichern.

Routendefinition

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

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Diese Route ist so konfiguriert, dass sie HTTP-POST-Anfragen an den Stammweg / verarbeitet;
  • Sie nutzt die Middleware validatePostData, die sicherstellt, dass die im Anforderungskörper gesendeten Daten gültig sind, bevor fortgefahren wird.

Datenvalidierungs-Middleware

Bevor wir uns mit der Logik der Route befassen, müssen wir eine Datenvalidierungs-Middleware erstellen. Diese Middleware stellt sicher, dass die im Anforderungstext 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 Anforderungstext;
  • Sie überprüft, ob diese Felder vorhanden sind. Wenn eines von ihnen fehlt (!username, !postTitle oder !postContent), antwortet sie mit einem 400 (Bad Request) Statuscode und einer Fehlermeldung, die auf fehlende erforderliche Felder hinweist;
  • Wenn die Daten gültig sind, ruft die Middleware next() auf, wodurch die Anforderung zum Routen-Handler (in diesem Fall die "CREATE POST"-Route) fortgesetzt wird.

Mit der Datenvalidierungs-Middleware an Ort und Stelle, lassen Sie uns mit der Logik der "CREATE POST"-Route fortfahren.

Neue Beitragsdaten

Um einen neuen Beitrag zu erstellen, generieren wir eine eindeutige ID mit Date.now().toString(). Zusätzlich extrahieren wir username, postTitle und postContent aus dem Anforderungstext.

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

Den neuen Beitrag zur Datenbank hinzufügen

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 erklärt;
  • Der neue Beitrag wird dem data-Array hinzugefügt;
  • Das aktualisierte data-Array wird dann zurück in die JSON-Datei geschrieben, um den neu erstellten Beitrag zu speichern.

Senden einer Antwort

Nach erfolgreicher Erstellung des neuen Beitrags wird eine Erfolgsantwort an den Client gesendet. Die Antwort enthält einen Statuscode von 201 (Created) und die Details des neu erstellten Beitrags im JSON-Format.

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

Fehlerbehandlung

Wir umschließen den Routencode in einem Try-Catch-Block, um potenzielle Fehler bei der Datenabfrage oder der Anforderungsverarbeitung zu behandeln. Alle auftretenden Fehler werden zur Debugging-Zwecken 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

course content

Kursinhalt

Backend-Entwicklung mit Node.js und Express.js

Backend-Entwicklung mit Node.js und Express.js

1. Einführung
2. Konsolenanwendungen
3. Express.js Framework
4. Entwicklung von REST-API

book
Implementierung der "Create Post"-Route

Wir werden die Erstellung eines neuen Beitrags mit der Route "CREATE POST" innerhalb der Datei postsRoutes.js untersuchen. Diese Route ist dafür verantwortlich, die Erstellung eines Beitrags zu bearbeiten und ihn in der Datenquelle (database/posts.json) zu speichern.

Routendefinition

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

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Diese Route ist so konfiguriert, dass sie HTTP-POST-Anfragen an den Stammweg / verarbeitet;
  • Sie nutzt die Middleware validatePostData, die sicherstellt, dass die im Anforderungskörper gesendeten Daten gültig sind, bevor fortgefahren wird.

Datenvalidierungs-Middleware

Bevor wir uns mit der Logik der Route befassen, müssen wir eine Datenvalidierungs-Middleware erstellen. Diese Middleware stellt sicher, dass die im Anforderungstext 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 Anforderungstext;
  • Sie überprüft, ob diese Felder vorhanden sind. Wenn eines von ihnen fehlt (!username, !postTitle oder !postContent), antwortet sie mit einem 400 (Bad Request) Statuscode und einer Fehlermeldung, die auf fehlende erforderliche Felder hinweist;
  • Wenn die Daten gültig sind, ruft die Middleware next() auf, wodurch die Anforderung zum Routen-Handler (in diesem Fall die "CREATE POST"-Route) fortgesetzt wird.

Mit der Datenvalidierungs-Middleware an Ort und Stelle, lassen Sie uns mit der Logik der "CREATE POST"-Route fortfahren.

Neue Beitragsdaten

Um einen neuen Beitrag zu erstellen, generieren wir eine eindeutige ID mit Date.now().toString(). Zusätzlich extrahieren wir username, postTitle und postContent aus dem Anforderungstext.

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

Den neuen Beitrag zur Datenbank hinzufügen

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 erklärt;
  • Der neue Beitrag wird dem data-Array hinzugefügt;
  • Das aktualisierte data-Array wird dann zurück in die JSON-Datei geschrieben, um den neu erstellten Beitrag zu speichern.

Senden einer Antwort

Nach erfolgreicher Erstellung des neuen Beitrags wird eine Erfolgsantwort an den Client gesendet. Die Antwort enthält einen Statuscode von 201 (Created) und die Details des neu erstellten Beitrags im JSON-Format.

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

Fehlerbehandlung

Wir umschließen den Routencode in einem Try-Catch-Block, um potenzielle Fehler bei der Datenabfrage oder der Anforderungsverarbeitung zu behandeln. Alle auftretenden Fehler werden zur Debugging-Zwecken 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