Criando sua Primeira API com Node.js e TypeScript

Criar uma API (Interface de Programação de Aplicações) é uma das tarefas mais comuns e essenciais para desenvolvedores backend. Uma API permite que diferentes aplicações se comuniquem entre si, permitindo que você crie aplicações mais robustas e escaláveis. Neste post, vamos aprender a criar uma API simples utilizando Node.js e TypeScript. Se você é um iniciante no mundo do desenvolvimento backend, este guia é perfeito para você!

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes pré-requisitos instalados em sua máquina:

1. Node.js (versão 14 ou superior) - Você pode baixar a versão mais recente em nodejs.org.
2. npm - O gerenciador de pacotes que vem junto com o Node.js.
3. TypeScript - Para instalar o TypeScript globalmente, execute o seguinte comando:

   npm install -g typescript

1. Um editor de código - Podemos usar Visual Studio Code, que é amplamente utilizado na comunidade.

Conceitos Básicos

O que é Node.js?

Node.js é um ambiente de execução JavaScript no lado do servidor. Ele permite que você execute código JavaScript fora de um navegador, oferecendo um grande conjunto de funcionalidades para desenvolver servidores e aplicações web.

O que é TypeScript?

TypeScript é uma linguagem de programação que se baseia no JavaScript, adicionando tipagem estática e outros recursos que ajudam a construir aplicações mais robustas e menos propensas a erros.

Criando seu Projeto

Agora que você já tem os pré-requisitos, vamos criar um projeto básico de API.

1. Crie uma nova pasta para o projeto e entre nela:

   mkdir minha-api && cd minha-api

1. Inicialize um novo projeto Node.js:

   npm init -y

1. Instale as dependências necessárias:

   npm install express
   npm install --save-dev typescript @types/node @types/express ts-node

1. Adicione um arquivo de configuração do TypeScript: Crie um arquivo tsconfig.json com o seguinte conteúdo:

{
	"compilerOptions": {
		"target": "ES6",
		"module": "commonjs",
		"strict": true,
		"esModuleInterop": true,
		"skipLibCheck": true,
		"forceConsistentCasingInFileNames": true
	},
	"include": ["src/**/*"]
}

1. Crie a estrutura do projeto: Crie uma pasta src onde ficará o código da API.
2. Crie o arquivo principal da sua API: No diretório src, crie um arquivo chamado server.ts e adicione o seguinte código:

import express from 'express'

const app = express()
const PORT = process.env.PORT || 3000

app.use(express.json())

app.get('/api', (req, res) => {
	res.send('Bem-vindo à sua API!')
})

app.listen(PORT, () => {
	console.log(`Servidor rodando na porta ${PORT}`)
})

1. Para iniciar sua API, adicione um script no seu package.json:

   "scripts": {
     "start": "ts-node src/server.ts"
   }

1. Agora você pode iniciar sua API:

   npm start

1. Acesse sua API pelo navegador ou ferramenta de API (como Postman) em:

   http://localhost:3000/api

Mini-Projeto Prático

Para praticar, você pode expandir essa API, adicionando novas rotas. Por exemplo, crie uma rota para retornar uma lista de usuários:

let usuarios: string[] = ['João', 'Maria', 'Pedro']

app.get('/api/usuarios', (req, res) => {
	res.json(usuarios)
})

Agora, ao acessar http://localhost:3000/api/usuarios, você verá a lista de usuários!

Padrões de Projeto Aconselháveis

• Separação de Concerns: Ao criar uma API maior, considere separar as rotas, controladores e serviços em arquivos diferentes.
• Middleware: Utilize middlewares para gerenciar autenticação, tratamento de erros e validar dados.
• Documentação: Use ferramentas como Swagger para documentar sua API, o que facilita a compreensão para outros desenvolvedores.

Dicas para Próximos Passos

• Aprenda sobre banco de dados e como integrá-los com sua API (exemplos: MongoDB, PostgreSQL).
• Explore autenticação (JWT, OAuth2) para proteger suas rotas.
• Experimente usar o Docker para containerizar sua aplicação.

Possíveis Erros e Soluções

• Erro: CORS: Se você receber um erro de CORS (Cross-Origin Resource Sharing), adicione o middleware cors ao seu projeto:

  npm install cors

E no seu arquivo server.ts:

import cors from 'cors'
app.use(cors())

Links para Materiais de Apoio

• Documentação do Node.js
• Documentação do Express
• Documentação do TypeScript

Com isso, você deu seus primeiros passos na criação de APIs com Node.js e TypeScript. Continue praticando e explorando essa tecnologia poderosa!