Oppo API V1.0.1

ESTE PROJETO FOI DESCONTINUADO HÁ UM TEMPO

Gestão Escolar Completa e Efetiva

Descrição

A Oppo API é uma solução voltada para a gestão de escolas de pequeno porte, que não podem gastar muito para sua gestão, permitindo o controle de turmas, alunos, professores e matérias. A seguir, estão descritas as funcionalidades já implementadas e as necessidades que o sistema supre.

---

Necessidades Supridas

1. Gestão de Escolas

• Criar e Atualizar Escolas:
  A API permite a criação de novas escolas e a atualização das informações de escolas existentes.
  Necessidade suprida: Cadastro e manutenção de dados institucionais.

2. Gestão de Alunos na Escola

• Adicionar e Remover Alunos:
  As escolas podem matricular ou remover alunos de seu banco de dados, facilitando o controle de matrícula.

• Listar Alunos da Escola:
  Visualização da lista de alunos matriculados em uma escola específica.
  Necessidade suprida: Gerenciamento de matrículas e controle de alunos ativos.

3. Gestão de Professores na Escola

• Adicionar e Remover Professores:
  As escolas podem adicionar novos professores ao quadro docente ou removê-los quando necessário.

• Listar Professores da Escola:
  Visualização da lista de professores atuantes em uma escola.
  Necessidade suprida: Gerenciamento de recursos humanos (professores).

4. Gestão de Turmas

• Criar e Deletar Turmas:
  Possibilidade de criação de novas turmas e exclusão de turmas antigas.

• Listar Turmas:
  A API permite visualizar todas as turmas criadas em uma escola específica.

• Adicionar e Remover Matérias nas Turmas:
  Flexibilidade para adicionar ou remover matérias específicas em cada turma.

• Matricular e Mover Alunos entre Turmas:
  Alunos podem ser matriculados em turmas ou transferidos para outras turmas conforme necessário.
  Necessidade suprida: Organização e gerenciamento de turmas, alocação de alunos e matérias.

5. Gestão de Matérias

• Criar e Deletar Matérias:
  As escolas podem gerenciar o currículo, criando novas matérias ou removendo aquelas que não fazem mais parte do programa.

• Adicionar Professor Responsável por Matérias:
  Função para alocar professores às matérias, garantindo que cada disciplina tenha seu docente.

• Listar Matérias da Escola:
  A API permite visualizar todas as matérias disponíveis na escola.
  Necessidade suprida: Gerenciamento do currículo escolar e alocação de professores às matérias.

---

Rotas Disponíveis

Escolas

• POST /escolas - Criar uma nova escola
• PUT /escolas/{id} - Atualizar dados de uma escola existente

Alunos

• POST /escolas/{idEscola}/alunos/{idAluno} - Adicionar aluno em uma escola
• DELETE /escolas/{idEscola}/alunos/{idAluno} - Remover aluno de uma escola
• GET /escolas/{idEscola}/alunos - Listar alunos de uma escola

Professores

• POST /escolas/{idEscola}/professores/{idProfessor} - Adicionar professor em uma escola
• DELETE /escolas/{idEscola}/professores/{idProfessor} - Remover professor de uma escola
• GET /escolas/{idEscola}/professores - Listar professores de uma escola

Turmas

• POST /escolas/{idEscola}/turmas - Criar uma turma em uma escola
• DELETE /escolas/{idEscola}/turmas/{idTurma} - Deletar uma turma
• GET /escolas/{idEscola}/turmas - Listar turmas de uma escola
• POST /escolas/{idEscola}/turmas/{idTurma}/materias - Adicionar matéria em uma turma
• DELETE /escolas/{idEscola}/turmas/{idTurma}/materias/{idMateria} - Remover matéria de uma turma
• POST /escolas/{idEscola}/turmas/{idTurma}/alunos/{idAluno} - Matricular aluno em uma turma
• PUT /escolas/{idEscola}/turmas/{idTurma}/alunos/{idAluno} - Mover aluno de uma turma para outra

Matérias

• POST /materias - Criar uma nova matéria
• DELETE /materias/{idMateria} - Deletar uma matéria
• GET /materias - Listar todas as matérias
• POST /materias/{idMateria}/professores/{idProfessor} - Adicionar professor responsável por uma matéria

---

Instalação e Uso

Clone o repositório e siga os passos abaixo para rodar o projeto localmente.

git clone https://github.com/usuario/repo-oppo.git
cd repo-oppo

Desenvolvido por Erickson Dias