📝 Tasks API

API RESTful completa para gerenciamento de tarefas desenvolvida com TypeScript, Express, Prisma ORM e PostgreSQL. Inclui validação robusta, testes automatizados, paginação, documentação interativa e recursos de segurança.

🚀 Tecnologias

Core

Node.js - Runtime JavaScript
TypeScript - Tipagem estática
Express - Framework web minimalista
Prisma ORM - ORM moderno para TypeScript
PostgreSQL - Banco de dados relacional

Validação e Testes

Zod - Validação de schemas com type inference
Vitest - Framework de testes ultrarrápido
Supertest - Testes de integração HTTP

Segurança e Performance

Helmet - Segurança com headers HTTP
CORS - Cross-Origin Resource Sharing
Express Rate Limit - Proteção contra rate limiting

Documentação

Swagger/OpenAPI - Documentação interativa da API

DevOps

Docker - Containerização do PostgreSQL
ESLint - Linter para código TypeScript
Prettier - Formatação de código

📋 Funcionalidades

✅ CRUD completo de tarefas
✅ Paginação e filtros avançados
✅ Busca por título ou descrição
✅ Filtrar por status (concluídas/pendentes)
✅ Marcar como concluída/pendente
✅ Validação robusta com Zod
✅ Testes automatizados com Vitest
✅ Documentação interativa com Swagger
✅ Rate limiting para proteção
✅ Importação em massa via CSV
✅ Tratamento global de erros

🗂️ Estrutura do Projeto

tasks-api/
├── prisma/
│   ├── migrations/           # Migrações do banco de dados
│   └── schema.prisma         # Schema do Prisma
├── src/
│   ├── config/
│   │   ├── database.ts       # Configuração do Prisma Client
│   │   ├── env.ts            # Variáveis de ambiente
│   │   └── swagger.ts        # Configuração do Swagger
│   ├── controllers/
│   │   └── task.controller.ts
│   ├── middlewares/
│   │   ├── error-handler.ts  # Tratamento global de erros
│   │   ├── rate-limit.ts     # Rate limiting
│   │   └── validate.ts       # Validação com Zod
│   ├── repositories/
│   │   └── task.repository.ts
│   ├── routes/
│   │   ├── index.ts
│   │   └── task.routes.ts
│   ├── schemas/
│   │   └── task.schema.ts    # Schemas Zod
│   ├── services/
│   │   └── task.service.ts
│   ├── types/
│   │   └── task.types.ts
│   └── server.ts             # Servidor Express
├── import-csv.js             # Script de importação CSV
├── docker-compose.yml        # PostgreSQL containerizado
├── vitest.config.ts          # Configuração de testes
├── tsconfig.json             # Configuração TypeScript
└── package.json

🔧 Instalação

Pré-requisitos

Node.js 20+
Docker e Docker Compose (ou PostgreSQL instalado)
npm ou yarn

Passo 1: Clone o repositório

git clone https://github.com/seu-usuario/tasks-api.git
cd tasks-api

Passo 2: Instale as dependências

npm install

Passo 3: Configure as variáveis de ambiente

Crie um arquivo .env na raiz do projeto:

# Server
PORT=3333
NODE_ENV=development
CORS_ORIGIN=*

# Database
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/tasks_db?schema=public"

Passo 4: Inicie o PostgreSQL

docker-compose up -d

Passo 5: Execute as migrações

npm run prisma:migrate

Passo 6: Inicie o servidor

npm run dev

O servidor estará rodando em:

🚀 API: http://localhost:3333
📚 Documentação: http://localhost:3333/api-docs

📚 Documentação da API

Acesse a documentação interativa completa em:

http://localhost:3333/api-docs

Estrutura de uma Tarefa

{
  "id": "uuid",
  "title": "Título da tarefa",
  "description": "Descrição detalhada",
  "completed_at": null | "2026-02-02T20:00:00.000Z",
  "created_at": "2026-02-02T20:00:00.000Z",
  "updated_at": "2026-02-02T20:00:00.000Z"
}

🔌 Endpoints

Health Check

GET /health

Resposta:

{
  "status": "ok",
  "timestamp": "2026-02-02T20:00:00.000Z",
  "environment": "development"
}

Criar Tarefa

POST /api/tasks
Content-Type: application/json

{
  "title": "Minha tarefa",
  "description": "Descrição da tarefa"
}

Resposta: 201 Created

Listar Tarefas (com paginação)

GET /api/tasks?page=1&limit=10&search=teste&completed=false

Query Parameters:

page (opcional) - Número da página (padrão: 1)
limit (opcional) - Itens por página (padrão: 10, máx: 100)
search (opcional) - Buscar por título ou descrição
completed (opcional) - Filtrar por status (true/false)

Resposta: 200 OK

{
  "data": [
    {
      "id": "uuid",
      "title": "Tarefa 1",
      "description": "Descrição",
      "completed_at": null,
      "created_at": "2026-02-02T20:00:00.000Z",
      "updated_at": "2026-02-02T20:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 50,
    "totalPages": 5
  }
}

Buscar Tarefa por ID

GET /api/tasks/:id

Resposta: 200 OK

Atualizar Tarefa

PUT /api/tasks/:id
Content-Type: application/json

{
  "title": "Título atualizado",
  "description": "Descrição atualizada"
}

Resposta: 200 OK

Validações:

Pelo menos um campo é obrigatório
O ID deve existir

Remover Tarefa

DELETE /api/tasks/:id

Resposta: 204 No Content

Marcar como Concluída/Pendente

PATCH /api/tasks/:id/complete

Alterna o status entre concluída e pendente.

Resposta: 200 OK

📥 Importação via CSV

Formato do Arquivo CSV

Crie um arquivo tasks.csv:

title,description
Tarefa 01,Descrição da tarefa 01
Tarefa 02,Descrição da tarefa 02
Tarefa 03,Descrição da tarefa 03

Executar Importação

node import-csv.js

🧪 Testes

Executar todos os testes

npm test

Executar com interface visual

npm run test:ui

Executar com cobertura

npm run test:coverage

Estrutura de Testes

✅ Testes unitários - Services, Repositories
✅ Testes de validação - Schemas Zod
✅ Testes de integração - Endpoints HTTP

🔒 Segurança

✅ Helmet - Proteção de headers HTTP
✅ CORS - Configuração de origens permitidas
✅ Rate Limiting - 100 requisições por 15 minutos
✅ Validação de entrada - Zod schemas
✅ Variáveis de ambiente - Credenciais protegidas
✅ UUID - IDs não sequenciais

📊 Banco de Dados

Visualizar dados

npm run prisma:studio

Abre interface visual em http://localhost:5555

Criar nova migration

npm run prisma:migrate

Resetar banco de dados

npx prisma migrate reset

🐳 Docker

Comandos úteis

# Iniciar PostgreSQL
docker-compose up -d

# Parar
docker-compose down

# Ver logs
docker-compose logs -f postgres

# Resetar dados
docker-compose down -v

# Acessar PostgreSQL
docker-compose exec postgres psql -U postgres -d tasks_db

📝 Scripts Disponíveis

{
  "dev": "Iniciar servidor em modo desenvolvimento",
  "build": "Compilar TypeScript para JavaScript",
  "start": "Iniciar servidor de produção",
  "test": "Executar testes",
  "test:ui": "Executar testes com UI",
  "test:coverage": "Executar testes com cobertura",
  "lint": "Verificar erros de linting",
  "lint:fix": "Corrigir erros de linting",
  "format": "Formatar código com Prettier",
  "prisma:generate": "Gerar Prisma Client",
  "prisma:migrate": "Executar migrações",
  "prisma:studio": "Abrir Prisma Studio"
}

🎯 Conceitos Aplicados

✅ Clean Architecture - Separação em camadas
✅ Repository Pattern - Abstração de acesso a dados
✅ Dependency Injection - Inversão de dependências
✅ DTOs - Data Transfer Objects
✅ Validation Layer - Validação em middleware
✅ Error Handling - Tratamento centralizado
✅ Type Safety - TypeScript strict mode
✅ Path Aliases - Imports organizados (@/)

🚀 Deploy

Variáveis de ambiente para produção

NODE_ENV=production
PORT=3333
CORS_ORIGIN=https://seu-frontend.com
DATABASE_URL=postgresql://user:password@host:5432/database

Build para produção

npm run build
npm start

🤝 Contribuindo

Fork o projeto
Crie uma branch (git checkout -b feat/nova-feature)
Commit suas mudanças (git commit -m 'feat: adiciona nova feature')
Push para a branch (git push origin feat/nova-feature)
Abra um Pull Request

Padrão de Commits

Usamos Conventional Commits:

feat: Nova funcionalidade
fix: Correção de bug
docs: Documentação
test: Testes
refactor: Refatoração
chore: Tarefas de manutenção

📄 Licença

Este projeto está sob a licença MIT.

👨‍💻 Autor

Bruno Miho - Full Stack Developer

🌟 Agradecimentos

Projeto desenvolvido como desafio de aprendizado, aplicando conceitos modernos de desenvolvimento backend com TypeScript e Node.js.

⭐ Se este projeto te ajudou, considere dar uma estrela!

Name		Name	Last commit message	Last commit date
Latest commit History 51 Commits
legacy		legacy
prisma		prisma
src		src
.env.example		.env.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierrc		.prettierrc
README.md		README.md
docker-compose.yml		docker-compose.yml
examples.http		examples.http
import-csv.js		import-csv.js
package-lock.json		package-lock.json
package.json		package.json
prisma.config.ts		prisma.config.ts
tasks.csv		tasks.csv
tsconfig.json		tsconfig.json
vitest.config.ts		vitest.config.ts

bruno-miho-dev/tasks-api

Folders and files

Latest commit

History

Repository files navigation

📝 Tasks API

🚀 Tecnologias

Core

Validação e Testes

Segurança e Performance

Documentação

DevOps

📋 Funcionalidades

🗂️ Estrutura do Projeto

🔧 Instalação

Pré-requisitos

Passo 1: Clone o repositório

Passo 2: Instale as dependências

Passo 3: Configure as variáveis de ambiente

Passo 4: Inicie o PostgreSQL

Passo 5: Execute as migrações

Passo 6: Inicie o servidor

📚 Documentação da API

Estrutura de uma Tarefa

🔌 Endpoints

Health Check

Criar Tarefa

Listar Tarefas (com paginação)

Buscar Tarefa por ID

Atualizar Tarefa

Remover Tarefa

Marcar como Concluída/Pendente

📥 Importação via CSV

Formato do Arquivo CSV

Executar Importação

🧪 Testes

Executar todos os testes

Executar com interface visual

Executar com cobertura

Estrutura de Testes

🔒 Segurança

📊 Banco de Dados

Visualizar dados

Criar nova migration

Resetar banco de dados

🐳 Docker

Comandos úteis

📝 Scripts Disponíveis

🎯 Conceitos Aplicados

🚀 Deploy

Variáveis de ambiente para produção

Build para produção

🤝 Contribuindo

Padrão de Commits

📄 Licença

👨‍💻 Autor

🌟 Agradecimentos

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages