Skip to main content

📊 Relatório de Progresso e Documentação das APIs – Plataforma Banco de Talentos

✅ Resumo Geral​

  • Total de rotas planejadas: 23
  • Rotas desenvolvidas: 11
  • Rotas pendentes: 12
  • Progresso: 48%

📘 Observações​

A estrutura de autenticação e rotas principais para estudantes e empresas está avançando bem. Em breve testaremos as APIs implementadas via ferramentas como Insomnia ou Postman para validação completa.

📘 Documentação das APIs Desenvolvidas

🔐 Autenticação​

POST /auth/login​

  • Descrição: Autentica um usuário (estudante ou empresa) com e-mail e senha.
  • Body JSON:
{
  "email": "usuario@example.com",
  "password": "senha123"
}
  • Resposta:
{
  "user": { "id": 1, "email": "usuario@example.com", ... },
  "token": "JWT_TOKEN"
}

👩‍🎓 Estudantes​

POST /students​

  • Descrição: Cria um novo estudante com nome, e-mail e senha.
  • Body JSON:
{
  "full_name": "Maria Silva",
  "email": "maria@email.com",
  "password": "senha123"
}

PUT /students/details​

  • Descrição: Complementa dados acadêmicos e de estágio do estudante.
  • Body JSON:
{
  "id": 1,
  "university": "USP",
  "scholarship_type": "Integral",
  "graduation_year": 2026,
  "next_year": 4,
  "current_job": "Estágio no MP"
}

PUT /students/update-profile​

  • Descrição: Atualiza o perfil completo do estudante, incluindo experiências, prêmios e atividades extracurriculares.
  • Body JSON:
{
  "id": 1,
  "bio": "Estudante apaixonada por direitos humanos...",
  "experiences": [ ... ],
  "awards": [ ... ],
  "extracurriculars": [ ... ]
}

DELETE /students/:id​

  • Descrição: Remove permanentemente um estudante pelo seu ID.

🏢 Empresas​

GET /companies​

  • Descrição: Lista todas as empresas cadastradas.

GET /companies/:id​

  • Descrição: Retorna os dados de uma empresa específica por ID.

PUT /companies/:id​

  • Descrição: Atualiza os dados de uma empresa por ID.
  • Body JSON:
{
  "name": "Escritório ABC",
  "description": "Foco em direito penal e constitucional",
  ...
}

DELETE /companies/:id​

  • Descrição: Remove permanentemente uma empresa pelo seu ID.

🔄 Próximos Passos​

  • Desenvolver rotas de jobs e applications
  • Criar testes com Insomnia/Postman para validação da API
  • Implementar middleware de autenticação nas demais rotas sensíveis

📅 Status das APIs

✅ APIs Desenvolvidas​

  • Login — POST /auth/login
  • Registro Estudante — POST /auth/register/student
  • Registro Empresa — POST /auth/register/company
  • Listar estudantes — GET /students
  • Buscar estudante por ID — GET /students/:id
  • Atualizar estudante — PUT /students/:id
  • Deletar estudante — DELETE /students/:id
  • Listar empresas — GET /companies
  • Buscar empresa por ID — GET /companies/:id
  • Atualizar empresa — PUT /companies/:id
  • Deletar empresa — DELETE /companies/:id

⏳ APIs Não Iniciadas​

  • Criar vaga — POST /jobs
  • Listar vagas — GET /jobs
  • Detalhes da vaga — GET /jobs/:id
  • Editar vaga — PUT /jobs/:id
  • Deletar vaga — DELETE /jobs/:id
  • Enviar candidatura — POST /applications
  • Listar candidaturas — GET /applications
  • Ver candidatura — GET /applications/:id
  • Cancelar candidatura — DELETE /applications/:id
  • Refino + paginação jobs — GET /jobs
  • Filtros jobs — GET /jobs
  • Refino aplicações — GET /applications