Papacapim API

Backend API RESTful para a rede social Papacapim, desenvolvida com Node.js, TypeScript, Fastify e PostgreSQL.

💡 Projeto inspirado na API api.papacapim.just.pro.br. O objetivo deste repositório é reproduzir as funcionalidades e endpoints da API original para fins de aprendizado e desenvolvimento.

🚀 Tecnologias

• Node.js 22 - Runtime JavaScript
• TypeScript - Superset tipado do JavaScript
• Fastify - Framework web rápido e leve
• Drizzle ORM - ORM TypeScript para PostgreSQL
• PostgreSQL - Banco de dados relacional
• Zod - Validação de schemas
• Swagger - Documentação da API
• Docker - Containerização
• bcrypt - Hash de senhas
• Vitest - Framework de testes unitários e E2E
• Supertest - Testes de integração HTTP
• Faker.js - Geração de dados aleatórios para testes
• ESLint - Padronização de código e linting

📋 Pré-requisitos

• Node.js v22+
• Docker & Docker Compose
• npm ou yarn

🔧 Instalação e Configuração

1. Clone o repositório

cd api

2. Instale as dependências

npm install

3. Configure as variáveis de ambiente

Copie o arquivo .env.example para .env:

cp .env.example .env

Edite o arquivo .env conforme necessário:

# Server
PORT=3333

# Database
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/papacapim

# JWT
JWT_SECRET=your-secret-key-change-this-in-production

4. Inicie o PostgreSQL com Docker

docker compose up -d postgres

5. Gere e execute as migrations

npm run db:generate
npm run db:migrate

6. Inicie o servidor de desenvolvimento

npm run dev

A API estará disponível em http://localhost:3333

📖 Documentação da API

A documentação completa das rotas e esquemas está disponível através do Swagger UI.

Acesse em: http://localhost:3333/docs

🧪 Testes

O projeto utiliza Vitest para testes automatizados, Supertest para requisições HTTP e Faker.js para geração de massas de dados.

Configuração

Certifique-se de criar um arquivo .env.test com as configurações do banco de dados de teste (diferente do desenvolvimento).

Executando os testes

# Rodar suite de testes
npm run test

# Rodar em modo watch (desenvolvimento)
npm run test:watch

# Verificar cobertura de código
npm run test:coverage

🐳 Docker

Executar com Docker Compose

Inicie todos os serviços:

docker compose up -d

Parar serviços:

docker compose down

Apenas PostgreSQL

docker compose up -d postgres

📝 Scripts

• npm run dev - Inicia o servidor de desenvolvimento
• npm run build - Compila o projeto para produção
• npm start - Inicia o servidor de produção
• npm run db:generate - Gera migrations do Drizzle
• npm run db:migrate - Executa migrations

🏗️ Estrutura do Projeto

api/
├── src/
│   ├── drizzle/
│   │   ├── schema/          # Schemas do banco de dados
│   │   │   ├── users.ts
│   │   │   ├── sessions.ts
│   │   │   ├── posts.ts
│   │   │   ├── followers.ts
│   │   │   └── likes.ts
│   │   ├── migrations/      # Migrations Drizzle
│   │   └── index.ts         # Conexão do banco
│   ├── functions/           # Funções utilitárias
│   │   ├── hash-password.ts
│   │   ├── verify-password.ts
│   │   └── generate-token.ts
│   ├── routes/              # Rotas da API
│   │   ├── sessions/
│   │   ├── users/
│   │   ├── followers/
│   │   ├── posts/
│   │   └── likes/
│   ├── env.ts               # Validação de variáveis de ambiente
│   └── server.ts            # Configuração do servidor Fastify
├── .env                     # Variáveis de ambiente
├── .env.example             # Template de variáveis
├── docker-compose.yml       # Configuração Docker
├── Dockerfile               # Imagem Docker
├── drizzle.config.ts        # Configuração Drizzle
├── tsconfig.json            # Configuração TypeScript
├── tsup.config.ts           # Configuração build
└── package.json

🔒 Autenticação

A API utiliza tokens de sessão para autenticação. Após fazer login via /sessions, utilize o token retornado no header x-session-token nas requisições que necessitam autenticação.

🗄️ Banco de Dados

Schema

• users: Usuários do sistema
• sessions: Sessões de autenticação
• posts: Postagens e respostas
• followers: Relacionamento de seguidores
• likes: Curtidas em postagens

Todas as tabelas possuem relacionamentos com cascade delete para manter a integridade referencial.

📄 Licença

ISC

👤 Autor

Desenvolvido como réplica local da API Papacapim por Diogo Mascarenhas