Skip to content
BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
src
src
 
 
.env
.env
 
 
.env.exemplo
.env.exemplo
 
 
README.md
README.md
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
sql-diagram.png
sql-diagram.png
 
 

Repository files navigation

🧑‍⚖️ API RESTful - Sistema de Controle de Advogados e Processos

Este projeto é uma API RESTful desenvolvida em Node.js com Express que permite gerenciar usuários, advogados e processos judiciais.
Foi criada para um escritório de advocacia, onde apenas usuários autenticados podem cadastrar, atualizar e excluir dados.

Sistema de Controle de Advogados e Processos

Objetivo

Aplicar conceitos de desenvolvimento back-end com:

  • Arquitetura MVC
  • Banco de dados MySQL
  • ORM Sequelize
  • Autenticação com JWT (JSON Web Token)
  • Validação com AJV
  • Documentação automática com Swagger

📂 Estrutura do Projeto

api-advogados/                                               # Ponto de partida do projeto
              ├── node_modules/                              # Dependências instaladas pelo npm/yarn
              ├── src/                                       # Código-fonte principal
              │   ├── config/                                # Configurações da aplicação
              │   │          └── database.js                 # Conexão com o banco de dados (Sequelize/Mongoose)
              │   ├── controllers/                           # Lógica dos endpoints
              │   │               ├── advogadoController.js  # CRUD de advogados
              │   │               ├── processoController.js  # CRUD de processos
              │   │               └── usuarioController.js   # Cadastro e login de usuários
              │   ├── middlewares/                           # Intermediários do Express
              │   │               ├── auth.js                # Validação de JWT (autenticação)
              │   │               ├── errorHandler.js        # Tratamento global de erros
              │   │               └── validateAjv.js         # Validação de dados usando schemas AJV
              │   ├── models/                                # Modelos de dados (ORM/ODM)
              │   │          ├── advogado.js                 # Model de advogados (nome, OAB, email)
              │   │          ├── index.js                    # Importa e exporta todos os models
              │   │          ├── processo.js                 # Model de processos (número, cliente, status)
              │   │          └── usuario.js                  # Model de usuários (nome, email, senha)
              │   ├── routes/                                # Definição das rotas da API
              │   │          ├── advogadoRoutes.js           # Rotas de advogados
              │   │          ├── processoRoutes.js           # Rotas de processos
              │   │          └── usuarioRoutes.js            # Rotas de usuários
              │   ├── schemas/                               # Schemas de validação de dados
              │   │           ├── advogadoSchemas.js         # Valida advogados (nome, OAB, email)
              │   │           ├── module.exports.js          # Centraliza todos os schemas para importação
              │   │           ├── processoSchemas.js         # Valida processos (número, cliente, status)
              │   │           └── usuarioSchemas.js          # Valida usuários (cadastro/login)│
              │   ├── app.js                                 # Configuração do Express (middlewares, rotas)
              │   ├── index.js                               # Ponto de entrada da aplicação
              │   ├── server.js                              # Inicializa servidor (porta, logs)
              │   └── swagger.js                             # Configuração da documentação Swagger/OpenAPI
              ├── .env                                       # Variáveis de ambiente (sensíveis)
              ├── .env.example                               # Exemplo de variáveis de ambiente
              ├── package-lock.json                          # Controle de versões das dependências
              ├── package.json                               # Metadados e scripts do projeto
              ├── README.md                                  # Este arquivo de documentação
              └── sql-diagram.png                            # Diagrama visual do banco de dados (DER)

💻 Pré-requisitos

Antes de começar, é necessário ter instalado:

*Node.js (v18+) *MySQL (v8+) *Git *Insomnia ou Postman

🧩 Passo a passo para rodar o projeto (para iniciantes)

🧩 1️⃣ Baixar o projeto

Abra o terminal (ou Git Bash) e execute:

git clone https://github.com/jonatan200805/api-advogados.git

💡 Ou, se preferir, baixe o arquivo ZIP do repositório e extraia em seu computador.

📁 2️⃣ Acessar a pasta do projeto

cd api-advogados

⚙️ 3️⃣ Instalar as dependências

npm install

Isso vai baixar todas as bibliotecas necessárias (Express, Sequelize, JWT, Ajv, etc).

🛢️ 4️⃣ Configurar o banco de dados

Crie um banco de dados MySQL com o nome advogados_db:

CREATE DATABASE advogados_db;

Depois, crie um arquivo .env na raiz do projeto com as seguintes informações:

DB_HOST=localhost
DB_USER=root
DB_PASS=sua_senha
DB_NAME=advogados_db
JWT_SECRET=meusegredo123
PORT=3000

⚠️ Substitua sua_senha pela senha real do seu MySQL.

▶️ 5️⃣ Executar o projeto

npm run dev

Se tudo estiver certo, você verá no terminal:

✅ Conexão com o banco de dados estabelecida!
🚀 Servidor rodando na porta 3000

💡 Se o sequelize.sync() estiver habilitado, as tabelas serão criadas automaticamente.

Sistema de Gerenciamento de Advogados e Processos API em Node.js + Express + Sequelize + MySQL

📖 Descrição do Projeto

Este projeto implementa um sistema de gerenciamento de usuários, advogados e processos jurídicos, permitindo cadastro, visualização e relacionamento entre eles.

A API segue uma arquitetura simples, organizada e baseada em boas práticas REST.

🧱 Modelo Relacional do Banco de Dados

usuario (1) ---- (N) advogado (1) ---- (N) processo

usuario

*id (PK) *nome *email (UNIQUE) *senha

advogado

*id (PK) *nome *oab (UNIQUE) *especialidade *id_usuario (FK → usuario.id)

processo

*id (PK) *numero_processo (UNIQUE) *descricao *status *id_advogado (FK → advogado.id)

🛠 Criação do Banco de Dados no MySQL

Criar Banco

CREATE DATABASE sistema_advogados;
USE sistema_advogados;

🗄 Criação das Tabelas

Tabela: usuario

CREATE TABLE usuario (
    id INT AUTO_INCREMENT PRIMARY KEY,
    nome VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL UNIQUE,
    senha VARCHAR(255) NOT NULL
);

Tabela: advogado

CREATE TABLE advogado (
    id INT AUTO_INCREMENT PRIMARY KEY,
    nome VARCHAR(255) NOT NULL,
    oab VARCHAR(50) NOT NULL UNIQUE,
    especialidade VARCHAR(255),
    id_usuario INT NOT NULL,
    FOREIGN KEY (id_usuario) REFERENCES usuario(id)
);

Tabela: processo

CREATE TABLE processo (
    id INT AUTO_INCREMENT PRIMARY KEY,
    numero_processo VARCHAR(100) NOT NULL UNIQUE,
    descricao TEXT,
    status VARCHAR(100),
    id_advogado INT NOT NULL,
    FOREIGN KEY (id_advogado) REFERENCES advogado(id)
);

Aqui está essa parte explicada e formatada direitinho, como ficaria no README.md, incluindo a palavra que você pediu: ramem (vou colocá-la ao final como um comentário).

Criar Índices (opcional, mas recomendado)**

Índices servem para melhorar a velocidade de consultas que filtram por colunas específicas. No seu banco, as colunas que mais serão usadas em buscas são:

  • id_usuario na tabela advogado
  • id_advogado na tabela processo

Criar índices melhora muito a performance da API quando ela usa JOINs e SELECTs com filtros.

✅ Criar índices recomendados

CREATE INDEX idx_advogado_usuario ON advogado (id_usuario);
CREATE INDEX idx_processo_advogado ON processo (id_advogado);

✔ Benefícios dos índices

  • Acelera consultas com JOIN
  • Acelera consultas com WHERE
  • Melhora o desempenho geral da API Node.js
  • Reduz o tempo de resposta

🧹 Como Deletar Todas as Tabelas

Opção fácil (desativa FKs)

SET FOREIGN_KEY_CHECKS = 0;

DROP TABLE IF EXISTS processo;
DROP TABLE IF EXISTS advogado;
DROP TABLE IF EXISTS usuario;

SET FOREIGN_KEY_CHECKS = 1;

Ou deletar na ordem correta:

DROP TABLE processo;
DROP TABLE advogado;
DROP TABLE usuario;

📝 Inserts de Teste

Usuário

INSERT INTO usuario (nome, email, senha)
VALUES ('João Silva', 'joao@email.com', '1234');

Advogado

INSERT INTO advogado (nome, oab, especialidade, id_usuario)
VALUES ('Maria Souza', '12345-OAB', 'Direito Civil', 1);

Processo

INSERT INTO processo (numero_processo, descricao, status, id_advogado)
VALUES ('PROC-2025-0001', 'Processo sobre contrato', 'Em andamento', 1);

📦 Tecnologias Utilizadas

*Node.js *Express *MySQL *Sequelize ORM *Dotenv *Nodemon

▶ Como Rodar o Projeto

1. Instalar dependências

npm install

2. Criar arquivo .env

DB_NAME=sistema_advogados
DB_USER=root
DB_PASS=SUASENHA
DB_HOST=localhost
DB_DIALECT=mysql

3. Rodar o servidor

npm run dev

🔗 Rotas (Exemplos)

Usuário

Método Rota Descrição
POST /usuario Cria usuário
GET /usuario Lista usuários

Advogado

Método Rota Descrição
POST /advogado Cria advogado
GET /advogado Lista advogados

Processo

Método Rota Descrição
POST /processo Cria processo
GET /processo Lista processos

✔ Status do Projeto

🚧 Em desenvolvimento 📘 Aceitando melhorias

📘 6️⃣ Acessar a documentação (Swagger)

Abra o navegador e entre em:

👉 http://localhost:3000/api-docs

📘 Dica: No Swagger UI, use o botão “Authorize” para inserir seu token JWT e testar as rotas protegidas.

🔐 Autenticação

👤 Criar usuário

POST /usuario

{
  "nome": "Maria Silva",
  "email": "maria@teste.com",
  "senha": "123456"
}

Retorna um token JWT.

🔑 Fazer login

POST /usuario/login

{
  "email": "maria@teste.com",
  "senha": "123456"
}

Copie o token retornado e envie nas próximas requisições no cabeçalho:

Authorization: Bearer SEU_TOKEN_AQUI

⚖️ Endpoints principais

👤 Usuário

Método Rota Descrição
POST /usuario Cria novo usuário
POST /usuario/login Faz login e retorna token

🧑‍⚖️ Advogado

Método Rota Descrição
GET /advogados Lista todos os advogados
POST /advogados Cadastra novo advogado
PUT /advogados/:id Atualiza advogado
DELETE /advogados/:id Remove advogado

📁 Processo

Método Rota Descrição
GET /advogados/:id_advogado/processos Lista processos de um advogado
POST /advogados/:id_advogado/processos Cria novo processo

🚀 Passo a passo — Testando TODAS as rotas POST

🧩 1️⃣ Criar Usuário

Rota: POST http://localhost:3000/api/usuarios

📦 Body (JSON):

{
  "nome": "Maria Silva",
  "email": "maria@teste.com",
  "senha": "123456"
}

📤 Resposta esperada:

{
  "message": "Usuário criado!",
  "data": {
    "nome": "Maria Silva",
    "email": "maria@teste.com",
    "senha": "123456"
  }
}

🔑 2️⃣ Fazer Login

Rota: POST http://localhost:3000/api/login

📦 Body (JSON):

{
  "email": "maria@teste.com",
  "senha": "123456"
}

📤 Resposta esperada:

{
  "message": "Login realizado com sucesso!",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6..."
}

⚠️ Importante: Copie o valor do "token" retornado — ele será usado nas próximas rotas protegidas (advogados e processos).

🧑‍⚖️ 3️⃣ Criar Advogado

Rota: POST http://localhost:3000/api/advogados

🔐 Headers:

Authorization: Bearer SEU_TOKEN_AQUI
Content-Type: application/json

📦 Body (JSON):

{
  "nome": "Dr. João Almeida",
  "oab": "12345-SP",
  "email": "joao@oab.com"
}

📤 Resposta esperada:

{
  "message": "Advogado criado!",
  "data": {
    "nome": "Dr. João Almeida",
    "oab": "12345-SP",
    "email": "joao@oab.com"
  }
}

📁 4️⃣ Criar Processo

Rota: POST http://localhost:3000/api/advogados/1/processos

Aqui o número 1 é o id do advogado que você acabou de criar.

🔐 Headers:


Authorization: Bearer SEU_TOKEN_AQUI
Content-Type: application/json

📦 Body (JSON):

{
  "numero_processo": "0001234-56.2024.8.26.0100",
  "descricao": "Ação de indenização por danos morais",
  "status": "Em andamento"
}

📤 Resposta esperada:

{
  "message": "Processo criado com sucesso!",
  "data": {
    "numero_processo": "0001234-56.2024.8.26.0100",
    "descricao": "Ação de indenização por danos morais",
    "status": "Em andamento",
    "id_advogado": 1
  }
}

🧩 5️⃣ Exemplo de Erro — Dados inválidos

Se faltar algum campo obrigatório (por exemplo, esquecer o email do advogado):

POST http://localhost:3000/api/advogados

📦 Body (JSON):

{
  "nome": "Dr. João"
}

📤 Resposta:

{
  "message": "Dados inválidos",
  "formattedErrors": "/oab (undefined) must have required property 'oab', /email (undefined) must have required property 'email'"
}

🧠 Resumo — Rotas POST da API

Módulo Método Rota Descrição Autenticação
Usuário POST /api/usuarios Cadastrar novo usuário ❌ Não
Login POST /api/login Realizar login e obter token ❌ Não
Advogado POST /api/advogados Cadastrar novo advogado ✅ Sim (JWT)
Processo POST /api/advogados/:id_advogado/processos Cadastrar novo processo para um advogado ✅ Sim (JWT)

💡 Dicas Finais

*Sempre envie o token JWT nas rotas protegidas (Authorization: Bearer SEU_TOKEN_AQUI). *Use Swagger (http://localhost:3000/api-docs) para testar as rotas visualmente. *Verifique no MySQL (banco advogados_db) se os registros estão sendo criados corretamente nas tabelas usuarios, advogados e processos.

🗑️ Como deletar todas as tabelas no MySQL (com segurança)

Existem duas formas de excluir todas as tabelas do banco: ✔ ignorando as chaves estrangeiras (mais fácil) ✔ seguindo a ordem de dependência (manual)

A forma mais prática é desativar temporariamente a verificação de chaves estrangeiras.

✅ Método 1 — Deletar tabelas ignorando as Foreign Keys (recomendado)

Use quando quiser apagar tudo sem receber erro de relacionamento.

SET FOREIGN_KEY_CHECKS = 0;

DROP TABLE IF EXISTS processo;
DROP TABLE IF EXISTS advogado;
DROP TABLE IF EXISTS usuario;

SET FOREIGN_KEY_CHECKS = 1;

✔ Benefícios

  • Evita erros como: "Cannot drop table because it is referenced by a foreign key constraint"
  • Permite apagar as tabelas em qualquer ordem
  • Útil para reiniciar o banco rapidamente

🔄 Método 2 — Deletar tabelas na ordem correta

Se quiser manter a verificação de FK ligada, siga a ordem de dependência:

  1. processo (depende de advogado)
  2. advogado (depende de usuario)
  3. usuario
DROP TABLE processo;
DROP TABLE advogado;
DROP TABLE usuario;

🧠 Tecnologias utilizadas

*🟢 Node.js

*⚙️ Express

*🗃️ Sequelize (ORM)

*🐬 MySQL

*🔐 JWT (autenticação)

*✅ AJV (validação de dados)

*📘 Swagger (documentação)

💾 Diagrama do Banco de Dados (ERD)

┌─────────────────────────┐
│        usuario          │
├─────────────────────────┤
│ id (PK)                 │
│ nome (VARCHAR)          │
│ email (VARCHAR, UNIQUE) │
│ senha (VARCHAR)         │
└─────────────────────────┘


┌─────────────────────────┐
│       advogado          │
├─────────────────────────┤
│ id (PK)                 │
│ nome (VARCHAR)          │
│ oab (VARCHAR, UNIQUE)   │
│ especialidade (VARCHAR) │
└─────────────────────────┘
             │
             │ 1:N
             ▼
┌─────────────────────────┐
│        processo         │
├─────────────────────────┤
│ id (PK)                 │
│ numero_processo (UNIQUE)│
│ descricao (TEXT)        │
│ status (VARCHAR)        │
│ id_advogado (FK)        │───► advogado.id
└─────────────────────────┘

🔗 Relações

*Usuário → acessa o sistema (autenticação JWT) *Advogado → cadastrado no sistema *Processo → pertence a um advogado (relação 1:N)

💡 Observações:

*Não é possível excluir um advogado que tenha processos vinculados. *Senhas são armazenadas com hash (bcrypt). *O campo numero_processo é único para garantir integridade.

🧾 Licença

📄 Este projeto foi desenvolvido apenas para fins educacionais. Sinta-se livre para clonar e adaptar conforme sua necessidade.

👨‍🏫 Créditos

Desenvolvido por: [Jonatan Cordova]

💻 Curso: Desenvolvimento Back-End com Node.js

📚 Projeto baseado em: Game-API / api-players-express

🔗 GitHub: https://github.com/jonatan200805

About

API RESTful para gestão de advogados e processos

github.com/jonatan200805/api-advogados

Topics

advogados-e-processos

Resources

Readme
Activity

Stars

2 stars

Watchers

0 watching

Forks

2 forks
Report repository

Releases

Packages

Contributors

Languages