Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Aprenda Configurando a Estrutura do Projeto | Construindo APIs REST com Node.js e Express.js
Desenvolvimento Backend com Node.js e Express.js

bookConfigurando a Estrutura do Projeto

Neste capítulo, analisaremos mais de perto a estrutura do projeto. Manter uma estrutura bem organizada torna-se fundamental à medida que desenvolvemos toda a aplicação. A seguir, destacamos os principais diretórios e arquivos que encontraremos em nosso projeto:

Arquivos Iniciais do Projeto

Você pode acessar os arquivos e pastas iniciais do projeto em Github Se você é novo no GitHub, siga o processo simples de dois passos ilustrado abaixo para baixar o projeto.

Visão Geral da Estrutura do Projeto

Vamos explorar a finalidade de cada diretório e arquivo. A imagem abaixo fornece uma representação visual da estrutura do projeto:

Agora, vamos analisar o propósito de cada diretório e arquivo:

  1. index.js: Serve como ponto de entrada principal da aplicação. Neste arquivo, configuramos o servidor Express, definimos middlewares, rotas e iniciamos o servidor;

    • Inicialização da aplicação Express;
    • Configuração de middlewares, como express.json(), para análise de requisições JSON;
    • Definição de rotas e middleware de tratamento de erros;
    • Inicialização do servidor Express em uma porta específica (por exemplo, 3000).
  2. routes/: Este diretório contém as definições de rotas para vários endpoints da API. Organizar as rotas em módulos separados ajuda a manter o código limpo;

    • Criação de arquivos de rotas distintos para diferentes funcionalidades (por exemplo, gerenciamento de usuários, tweets, posts, autenticação);
    • Organização e modularização do código de tratamento de rotas.
  3. routes/postsRoutes.js: Responsável especificamente pelo tratamento das rotas relacionadas a posts (tweets) na aplicação;

    • Definição de rotas para criação, recuperação, atualização e exclusão de posts (tweets);
    • Gerenciamento das interações com o arquivo de dados posts.json.
  4. middlewares/: Funções middleware armazenadas neste diretório são essenciais para tarefas como validação, autenticação e autorização. Promovem a reutilização de código;

    • Separação das funções middleware em módulos individuais;
    • Utilização de middleware para tarefas como validação de dados, autenticação de usuários e tratamento de erros.
  5. middlewares/validateData.js: Esta função middleware foca na validação dos dados das requisições recebidas. Garante que os dados enviados atendam aos critérios necessários;

    • Verificação da correção dos dados recebidos antes do processamento;
    • Respostas de erro apropriadas em casos de dados inválidos ou ausentes.
  6. database/: Este diretório armazena os dados da aplicação;

  7. database/posts.json: Neste arquivo, armazenamos nossos dados - neste caso, posts - em formato JSON;

  8. node_modules/: Gerado automaticamente ao executar npm i express, este diretório contém todas as bibliotecas e módulos externos utilizados no projeto;

  9. package.json e package-lock.json: Estes arquivos listam todos os pacotes dos quais o projeto depende.

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

Seção 4. Capítulo 3

Pergunte à IA

expand

Pergunte à IA

ChatGPT

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

Awesome!

Completion rate improved to 2.56

bookConfigurando a Estrutura do Projeto

Deslize para mostrar o menu

Neste capítulo, analisaremos mais de perto a estrutura do projeto. Manter uma estrutura bem organizada torna-se fundamental à medida que desenvolvemos toda a aplicação. A seguir, destacamos os principais diretórios e arquivos que encontraremos em nosso projeto:

Arquivos Iniciais do Projeto

Você pode acessar os arquivos e pastas iniciais do projeto em Github Se você é novo no GitHub, siga o processo simples de dois passos ilustrado abaixo para baixar o projeto.

Visão Geral da Estrutura do Projeto

Vamos explorar a finalidade de cada diretório e arquivo. A imagem abaixo fornece uma representação visual da estrutura do projeto:

Agora, vamos analisar o propósito de cada diretório e arquivo:

  1. index.js: Serve como ponto de entrada principal da aplicação. Neste arquivo, configuramos o servidor Express, definimos middlewares, rotas e iniciamos o servidor;

    • Inicialização da aplicação Express;
    • Configuração de middlewares, como express.json(), para análise de requisições JSON;
    • Definição de rotas e middleware de tratamento de erros;
    • Inicialização do servidor Express em uma porta específica (por exemplo, 3000).
  2. routes/: Este diretório contém as definições de rotas para vários endpoints da API. Organizar as rotas em módulos separados ajuda a manter o código limpo;

    • Criação de arquivos de rotas distintos para diferentes funcionalidades (por exemplo, gerenciamento de usuários, tweets, posts, autenticação);
    • Organização e modularização do código de tratamento de rotas.
  3. routes/postsRoutes.js: Responsável especificamente pelo tratamento das rotas relacionadas a posts (tweets) na aplicação;

    • Definição de rotas para criação, recuperação, atualização e exclusão de posts (tweets);
    • Gerenciamento das interações com o arquivo de dados posts.json.
  4. middlewares/: Funções middleware armazenadas neste diretório são essenciais para tarefas como validação, autenticação e autorização. Promovem a reutilização de código;

    • Separação das funções middleware em módulos individuais;
    • Utilização de middleware para tarefas como validação de dados, autenticação de usuários e tratamento de erros.
  5. middlewares/validateData.js: Esta função middleware foca na validação dos dados das requisições recebidas. Garante que os dados enviados atendam aos critérios necessários;

    • Verificação da correção dos dados recebidos antes do processamento;
    • Respostas de erro apropriadas em casos de dados inválidos ou ausentes.
  6. database/: Este diretório armazena os dados da aplicação;

  7. database/posts.json: Neste arquivo, armazenamos nossos dados - neste caso, posts - em formato JSON;

  8. node_modules/: Gerado automaticamente ao executar npm i express, este diretório contém todas as bibliotecas e módulos externos utilizados no projeto;

  9. package.json e package-lock.json: Estes arquivos listam todos os pacotes dos quais o projeto depende.

Tudo estava claro?

Como podemos melhorá-lo?

Obrigado pelo seu feedback!

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