Construa uma API RESTful com Node.js e MongoDB

A princípio, criar uma API eficiente pode parecer um desafio. Porém, com as ferramentas certas, como Node.js e MongoDB, esse processo se torna prático e até empolgante. Essas tecnologias são a combinação perfeita para desenvolvedores que buscam alta performance e flexibilidade. Neste artigo, você aprenderá a construir uma API RESTful com Node.js e MongoDB, explorando cada passo com detalhes.

Por que escolher Node.js e MongoDB?

Primeiramente, é essencial entender por que essas tecnologias são tão populares. Node.js é conhecido por sua alta velocidade e capacidade de lidar com múltiplas requisições simultâneas. Já o MongoDB oferece uma base de dados não relacional, ideal para estruturas flexíveis. Juntas, essas ferramentas são perfeitas para criar APIs modernas.

Além disso, elas são amplamente utilizadas por empresas líderes no mercado, o que prova sua eficácia. Quer acompanhar essa tendência? Continue lendo!

O que é uma API RESTful?

Antes de tudo, uma API RESTful é uma interface que permite a comunicação entre sistemas de forma padronizada. Em outras palavras, ela segue princípios claros, como a separação entre cliente e servidor, e o uso de métodos HTTP (GET, POST, PUT, DELETE). Com ela, é possível integrar diferentes plataformas de forma simples e eficiente.

Como preparar o ambiente de desenvolvimento?

Instale o Node.js

A princípio, você precisará do Node.js instalado no seu sistema. Acesse o site oficial e baixe a versão LTS. Essa instalação também inclui o npm, o gerenciador de pacotes do Node.js.

Configure o MongoDB

Depois disso, instale o MongoDB localmente ou use um serviço na nuvem, como o MongoDB Atlas. Configurar sua base de dados é essencial para começar a construir uma API RESTful com Node.js e MongoDB.

Ferramentas adicionais

• Postman: Para testar suas requisições.
• Visual Studio Code: Um editor de código intuitivo.

Estruturando seu projeto com Node.js

Inicie um novo projeto

Use o seguinte comando no terminal para criar seu projeto:

bashCopiar códigonpm init -y

Isso gerará o arquivo package.json, que é o coração do seu projeto.

Instale os pacotes necessários

Em seguida, instale os pacotes fundamentais para sua API:

bashCopiar códigonpm install express mongoose body-parser cors

• Express: Para gerenciar as rotas.
• Mongoose: Para interagir com o MongoDB.
• Body-parser: Para lidar com requisições JSON.
• Cors: Para permitir conexões de outros domínios.

Conectando Node.js ao MongoDB

Configure o banco de dados

Agora, crie um arquivo db.js para gerenciar a conexão:

javascriptCopiar código<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="431">const</span> mongoose = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="432">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="433">'mongoose'</span>);

mongoose.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="434">connect</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="435">'mongodb://localhost:27017/nomeDoBanco'</span>, {
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="436">useNewUrlParser</span>: <span class="hljs-literal" data-uipath_custom_id_23_4_59_15687="437">true</span>,
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="438">useUnifiedTopology</span>: <span class="hljs-literal" data-uipath_custom_id_23_4_59_15687="439">true</span>,
});

<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="440">const</span> db = mongoose.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="441">connection</span>;

db.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="442">on</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="443">'error'</span>, <span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="444">console</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="445">error</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="446">bind</span>(<span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="447">console</span>, <span class="hljs-string" data-uipath_custom_id_23_4_59_15687="448">'Erro de conexão:'</span>));
db.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="449">once</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="450">'open'</span>, <span class="hljs-function" data-uipath_custom_id_23_4_59_15687="451">() =&gt;</span> {
  <span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="452">console</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="453">log</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="454">'Conectado ao MongoDB!'</span>);
});

<span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="455">module</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="456">exports</span> = db;

Integre ao servidor

No seu arquivo principal (server.js), importe o banco:

javascriptCopiar código<span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="471">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="472">'./db'</span>);

Assim, sua aplicação estará conectada ao MongoDB.

Criando modelos com Mongoose

Através do Mongoose, você pode definir os modelos dos dados. Por exemplo, para um CRUD de usuários:

javascriptCopiar código<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="488">const</span> mongoose = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="489">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="490">'mongoose'</span>);

<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="491">const</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="492">UserSchema</span> = <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="493">new</span> mongoose.<span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="494">Schema</span>({
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="495">name</span>: <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="496">String</span>,
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="497">email</span>: <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="498">String</span>,
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="499">password</span>: <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="500">String</span>,
});

<span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="501">module</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="502">exports</span> = mongoose.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="503">model</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="504">'User'</span>, <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="505">UserSchema</span>);

Implementando rotas RESTful

Crie as rotas básicas

No arquivo routes.js, adicione:

javascriptCopiar código<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="521">const</span> express = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="522">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="523">'express'</span>);
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="524">const</span> router = express.<span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="525">Router</span>();
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="526">const</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="527">User</span> = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="528">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="529">'./models/User'</span>);

<span class="hljs-comment" data-uipath_custom_id_23_4_59_15687="530">// Rota GET</span>
router.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="531">get</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="532">'/users'</span>, <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="533">async</span> (req, res) =&gt; {
  <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="534">const</span> users = <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="535">await</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="536">User</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="537">find</span>();
  res.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="538">json</span>(users);
});

<span class="hljs-comment" data-uipath_custom_id_23_4_59_15687="539">// Rota POST</span>
router.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="540">post</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="541">'/users'</span>, <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="542">async</span> (req, res) =&gt; {
  <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="543">const</span> user = <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="544">await</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="545">User</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="546">create</span>(req.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="547">body</span>);
  res.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="548">json</span>(user);
});

<span class="hljs-comment" data-uipath_custom_id_23_4_59_15687="549">// Rota PUT</span>
router.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="550">put</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="551">'/users/:id'</span>, <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="552">async</span> (req, res) =&gt; {
  <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="553">const</span> user = <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="554">await</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="555">User</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="556">findByIdAndUpdate</span>(req.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="557">params</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="558">id</span>, req.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="559">body</span>, { <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="560">new</span>: <span class="hljs-literal" data-uipath_custom_id_23_4_59_15687="561">true</span> });
  res.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="562">json</span>(user);
});

<span class="hljs-comment" data-uipath_custom_id_23_4_59_15687="563">// Rota DELETE</span>
router.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="564">delete</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="565">'/users/:id'</span>, <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="566">async</span> (req, res) =&gt; {
  <span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="567">await</span> <span class="hljs-title class_" data-uipath_custom_id_23_4_59_15687="568">User</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="569">findByIdAndDelete</span>(req.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="570">params</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="571">id</span>);
  res.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="572">json</span>({ <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="573">message</span>: <span class="hljs-string" data-uipath_custom_id_23_4_59_15687="574">'Usuário removido com sucesso!'</span> });
});

<span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="575">module</span>.<span class="hljs-property" data-uipath_custom_id_23_4_59_15687="576">exports</span> = router;

Integre as rotas ao servidor

Por fim, no server.js, inclua:

javascriptCopiar código<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="591">const</span> express = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="592">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="593">'express'</span>);
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="594">const</span> app = <span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="595">express</span>();
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="596">const</span> cors = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="597">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="598">'cors'</span>);
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="599">const</span> bodyParser = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="600">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="601">'body-parser'</span>);
<span class="hljs-keyword" data-uipath_custom_id_23_4_59_15687="602">const</span> routes = <span class="hljs-built_in" data-uipath_custom_id_23_4_59_15687="603">require</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="604">'./routes'</span>);

app.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="605">use</span>(<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="606">cors</span>());
app.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="607">use</span>(bodyParser.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="608">json</span>());
app.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="609">use</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="610">'/api'</span>, routes);

app.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="611">listen</span>(<span class="hljs-number" data-uipath_custom_id_23_4_59_15687="612">3000</span>, <span class="hljs-function" data-uipath_custom_id_23_4_59_15687="613">() =&gt;</span> {
  <span class="hljs-variable language_" data-uipath_custom_id_23_4_59_15687="614">console</span>.<span class="hljs-title function_" data-uipath_custom_id_23_4_59_15687="615">log</span>(<span class="hljs-string" data-uipath_custom_id_23_4_59_15687="616">'Servidor rodando na porta 3000'</span>);
});

Agora, sua API está pronta para receber requisições!

Testando sua API

Com o Postman, envie requisições para as rotas criadas. Por exemplo, use o método POST para adicionar um usuário, enviando o seguinte JSON:

jsonCopiar código<span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="632">{</span>
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="633">"name"</span><span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="634">:</span> <span class="hljs-string" data-uipath_custom_id_23_4_59_15687="635">"João Silva"</span><span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="636">,</span>
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="637">"email"</span><span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="638">:</span> <span class="hljs-string" data-uipath_custom_id_23_4_59_15687="639">"[email protected]"</span><span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="640">,</span>
  <span class="hljs-attr" data-uipath_custom_id_23_4_59_15687="641">"password"</span><span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="642">:</span> <span class="hljs-string" data-uipath_custom_id_23_4_59_15687="643">"123456"</span>
<span class="hljs-punctuation" data-uipath_custom_id_23_4_59_15687="644">}</span>

Certifique-se de testar todas as rotas (GET, POST, PUT, DELETE) para garantir que sua API RESTful esteja funcionando perfeitamente.

Minhas Impressões Pessoais

Pessoalmente, acredito que construir uma API RESTful com Node.js e MongoDB é uma das melhores decisões para projetos modernos. A flexibilidade do MongoDB combinada com a agilidade do Node.js resulta em soluções rápidas e escaláveis. Além disso, a facilidade de integração com bibliotecas e ferramentas adicionais torna o processo ainda mais eficiente. Sem dúvida, essas tecnologias atendem às necessidades tanto de iniciantes quanto de profissionais experientes.

Conclusão

Por fim, aprender a construir uma API RESTful com Node.js e MongoDB é um passo essencial para qualquer desenvolvedor que deseja criar aplicações robustas e escaláveis. Dessa forma, com as etapas descritas neste artigo, você terá uma base sólida para avançar e explorar mais funcionalidades. Enfim, mãos à obra e boa codificação!

Perguntas Frequentes (FAQ)

• Arduino passo a passo – Seu guia completo
• Aprenda APIs Node.js de forma rápida e simples
• Explorando Angular 2 com TypeScript: Guia Completo para Desenvolvedores
• Fundamentos do MongoDB 3.2 para desenvolvedores – Aprenda com exercícios
• VueJS — O guia completo (incluindo Vue Router & Vuex)