API para sistema escolar

Descrição

Uma api Básica com o intuito de implementar uma tela de aluno em um sistema.

Modelo

O modelo da página foi criado no figma e pode ser encontrado aqui.

Diagrama de classes

classDiagram
    class Student {
      - Long id
      - String name
      - String grade
      - String registrationNumber
      - float cr
      - List<Notice> notices
      - List<Subject> subjects
      - Classroom classroom
    }

    class Notice {
      - Long id
      - String title
      - String body
    }

    class Subject {
      - Long id
      - String name
    }

    class Classroom {
      - Long id
      - String classCode
    }

    Student "1" *-- "many" Notice
    Student "1" *-- "many" Subject
    Student "many" -- "1" Classroom

Loading

Endpoints

Method	Route
GET	"/aluno"
GET	"/aluno/{id}"
POST	"/aluno"
DELETE	"/aluno/{id}"

Exemplo de uso

Criação de estudante em Json

{
  "id": 1,
  "name": "Patrick",
  "grade": "9º ano",
  "registrationNumber": "144192",
  "cr": 9.5,
  "notices": [
    {
      "id": 1,
      "title": "Aviso 1",
      "body": "Este é o primeiro aviso."
    },
    {
      "id": 2,
      "title": "Aviso 2",
      "body": "Este é o segundo aviso."
    }
  ],
  "subjects": [
    {
      "id": 1,
      "name": "Matemática"
    },
    {
      "id": 2,
      "name": "História"
    }
  ],
  "classroom": {
    "id": 1,
    "classCode": "T902"
  }
}

TODO

• Adcionar Curriculo como uma classe com matérias e notas
• Adcionar Professor, com um professor podendo dar aula pra uma matéria e uma matéria podendo ter vários professores.