Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Aprenda Construindo o Endpoint CREATE para Postagens | Construindo APIs REST com Node.js e Express.js
Desenvolvimento Backend com Node.js e Express.js

bookConstruindo o Endpoint CREATE para Postagens

Será analisada a criação de uma nova postagem utilizando a rota "CREATE POST" no arquivo postsRoutes.js. Esta rota é responsável por gerenciar a criação de uma postagem e salvá-la na fonte de dados (database/posts.json).

Definição da Rota

O código abaixo define a rota "CREATE POST" utilizando router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Esta rota está configurada para processar requisições HTTP POST no caminho raiz /;
  • Utiliza o middleware validatePostData, que garante que os dados enviados no corpo da requisição sejam válidos antes de prosseguir.

Middleware de Validação de Dados

Antes de entrar na lógica da rota, é necessário criar um middleware de validação de dados. Este middleware garante que os dados enviados no corpo da requisição sejam válidos antes de tentar criar uma nova postagem.

// 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();
}
  • A função validatePostData extrai username, postTitle e postContent do corpo da requisição;
  • Verifica se esses campos estão presentes. Se algum deles estiver ausente (!username, !postTitle ou !postContent), responde com o status 400 (Bad Request) e uma mensagem de erro indicando campos obrigatórios ausentes;
  • Se os dados forem válidos, o middleware chama next(), permitindo que a requisição continue para o handler da rota (neste caso, a rota "CREATE POST").

Com o middleware de validação de dados implementado, prossiga com a lógica da rota "CREATE POST".

Dados da Nova Postagem

Para criar uma nova postagem, é gerado um ID único utilizando Date.now().toString(). Além disso, são extraídos username, postTitle e postContent do corpo da requisição.

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

Adicionar a Nova Postagem ao Banco de Dados

Os passos a seguir detalham como a nova postagem é adicionada ao banco de dados:

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Os dados existentes são lidos do arquivo JSON utilizando a função assíncrona readData, conforme explicado anteriormente;
  • A nova postagem é adicionada ao array data;
  • O array data atualizado é então gravado novamente no arquivo JSON para salvar a nova postagem criada.

Enviando uma Resposta

Após a criação bem-sucedida de uma nova postagem, uma resposta de sucesso é enviada ao cliente. A resposta inclui um código de status 201 (Created) e os detalhes da nova postagem criada em formato JSON.

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

Tratamento de Erros

O código da rota é envolvido em um bloco try-catch para lidar com possíveis erros durante a recuperação de dados ou o processamento da requisição. Quaisquer erros que ocorrerem são registrados no console para fins de depuração:

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

Código completo do arquivo postsRoutes.js neste passo

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

Código completo do arquivo 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;

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

Seção 4. Capítulo 7

Pergunte à IA

expand

Pergunte à IA

ChatGPT

Pergunte o que quiser ou experimente uma das perguntas sugeridas para iniciar nosso bate-papo

Suggested prompts:

Can you explain how the validatePostData middleware works in more detail?

What happens if there is an error while writing to the posts.json file?

How can I test the "CREATE POST" route using a tool like Postman?

Awesome!

Completion rate improved to 2.56

bookConstruindo o Endpoint CREATE para Postagens

Deslize para mostrar o menu

Será analisada a criação de uma nova postagem utilizando a rota "CREATE POST" no arquivo postsRoutes.js. Esta rota é responsável por gerenciar a criação de uma postagem e salvá-la na fonte de dados (database/posts.json).

Definição da Rota

O código abaixo define a rota "CREATE POST" utilizando router.post():

router.post("/", validatePostData, async (req, res, next) => { ... }
  • Esta rota está configurada para processar requisições HTTP POST no caminho raiz /;
  • Utiliza o middleware validatePostData, que garante que os dados enviados no corpo da requisição sejam válidos antes de prosseguir.

Middleware de Validação de Dados

Antes de entrar na lógica da rota, é necessário criar um middleware de validação de dados. Este middleware garante que os dados enviados no corpo da requisição sejam válidos antes de tentar criar uma nova postagem.

// 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();
}
  • A função validatePostData extrai username, postTitle e postContent do corpo da requisição;
  • Verifica se esses campos estão presentes. Se algum deles estiver ausente (!username, !postTitle ou !postContent), responde com o status 400 (Bad Request) e uma mensagem de erro indicando campos obrigatórios ausentes;
  • Se os dados forem válidos, o middleware chama next(), permitindo que a requisição continue para o handler da rota (neste caso, a rota "CREATE POST").

Com o middleware de validação de dados implementado, prossiga com a lógica da rota "CREATE POST".

Dados da Nova Postagem

Para criar uma nova postagem, é gerado um ID único utilizando Date.now().toString(). Além disso, são extraídos username, postTitle e postContent do corpo da requisição.

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

Adicionar a Nova Postagem ao Banco de Dados

Os passos a seguir detalham como a nova postagem é adicionada ao banco de dados:

const data = await readData();
data.push(newPost);
await fs.writeFile("./database/posts.json", JSON.stringify(data));
  • Os dados existentes são lidos do arquivo JSON utilizando a função assíncrona readData, conforme explicado anteriormente;
  • A nova postagem é adicionada ao array data;
  • O array data atualizado é então gravado novamente no arquivo JSON para salvar a nova postagem criada.

Enviando uma Resposta

Após a criação bem-sucedida de uma nova postagem, uma resposta de sucesso é enviada ao cliente. A resposta inclui um código de status 201 (Created) e os detalhes da nova postagem criada em formato JSON.

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

Tratamento de Erros

O código da rota é envolvido em um bloco try-catch para lidar com possíveis erros durante a recuperação de dados ou o processamento da requisição. Quaisquer erros que ocorrerem são registrados no console para fins de depuração:

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

Código completo do arquivo postsRoutes.js neste passo

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

Código completo do arquivo 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;

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

Seção 4. Capítulo 7
some-alt