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

bookConstruindo o Endpoint GET Post por Id

Será explorada a implementação da rota "GET POST BY ID" no arquivo postsRoutes.js file. Esta rota recupera e retorna uma postagem específica com base em seu identificador único (id) fornecido como parte da URL.

Nota

O termo 'database' refere-se especificamente ao arquivo posts.json localizado na pasta database.

Definição da Rota

O código abaixo define a rota "GET POST BY ID" utilizando router.get():

router.get("/post/:id", async (req, res, next) => { ... }
  • Esta rota está configurada para lidar com requisições HTTP GET;
  • O caminho da rota /post/:id inclui um parâmetro :id, que captura o ID do post a partir da URL.

Extração do ID do Post

O ID do post é extraído dos parâmetros da requisição utilizando req.params.id:

const postId = req.params.id;

Esta linha captura o valor de :id da URL, tornando-o disponível para processamento posterior.

Busca do Post no Banco de Dados

Em seguida, é realizada a busca pelo post com o ID correspondente no banco de dados:

const data = await readData();

const post = data.find((post) => post.id === postId);
  • A função assíncrona readData é utilizada para recuperar os dados do arquivo JSON;
  • O método find() é empregado para localizar um post com o ID correspondente nos dados recuperados;
  • A variável post armazena o post encontrado ou undefined caso não haja correspondência.

Tratamento da Resposta

O tratamento da resposta é realizado com base em se um post foi encontrado ou não:

if (!post) {
  res.status(404).json({ error: "Post not found" });
} else {
  res.status(200).send(post);
}
  • Caso nenhum post seja encontrado (ou seja, post está undefined), uma resposta 404 é enviada juntamente com uma mensagem de erro, indicando que o post solicitado não foi encontrado;
  • Caso um post seja encontrado, o post é enviado como resposta com o código de status 200 (OK).

Tratamento de Erros

O código da rota é envolvido em um bloco try-catch para tratar possíveis erros durante a recuperação dos dados ou o processamento da requisição. Quaisquer erros que ocorram 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);
  }
});

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

Seção 4. Capítulo 6

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 readData function works in more detail?

What should I do if I get an error when trying to fetch a post by ID?

How can I test this GET POST BY ID route using a tool like Postman?

Awesome!

Completion rate improved to 2.56

bookConstruindo o Endpoint GET Post por Id

Deslize para mostrar o menu

Será explorada a implementação da rota "GET POST BY ID" no arquivo postsRoutes.js file. Esta rota recupera e retorna uma postagem específica com base em seu identificador único (id) fornecido como parte da URL.

Nota

O termo 'database' refere-se especificamente ao arquivo posts.json localizado na pasta database.

Definição da Rota

O código abaixo define a rota "GET POST BY ID" utilizando router.get():

router.get("/post/:id", async (req, res, next) => { ... }
  • Esta rota está configurada para lidar com requisições HTTP GET;
  • O caminho da rota /post/:id inclui um parâmetro :id, que captura o ID do post a partir da URL.

Extração do ID do Post

O ID do post é extraído dos parâmetros da requisição utilizando req.params.id:

const postId = req.params.id;

Esta linha captura o valor de :id da URL, tornando-o disponível para processamento posterior.

Busca do Post no Banco de Dados

Em seguida, é realizada a busca pelo post com o ID correspondente no banco de dados:

const data = await readData();

const post = data.find((post) => post.id === postId);
  • A função assíncrona readData é utilizada para recuperar os dados do arquivo JSON;
  • O método find() é empregado para localizar um post com o ID correspondente nos dados recuperados;
  • A variável post armazena o post encontrado ou undefined caso não haja correspondência.

Tratamento da Resposta

O tratamento da resposta é realizado com base em se um post foi encontrado ou não:

if (!post) {
  res.status(404).json({ error: "Post not found" });
} else {
  res.status(200).send(post);
}
  • Caso nenhum post seja encontrado (ou seja, post está undefined), uma resposta 404 é enviada juntamente com uma mensagem de erro, indicando que o post solicitado não foi encontrado;
  • Caso um post seja encontrado, o post é enviado como resposta com o código de status 200 (OK).

Tratamento de Erros

O código da rota é envolvido em um bloco try-catch para tratar possíveis erros durante a recuperação dos dados ou o processamento da requisição. Quaisquer erros que ocorram 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);
  }
});

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

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