Skip to content

API para controle de grades escolares, utilizando conceito de Rotas e a biblioteca winston para arquivos de log

Notifications You must be signed in to change notification settings

alm9/backend-grades-escolares-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Trabalho desenvolvido com Middlewares, gerando arquivos de log com a biblioteca winston.

A "grades-escolares" consiste em uma API para controlar notas de alunos em matérias de um curso. Os dados são guardados localmente, em arquivo.

OBJETIVO:

Desenvolver endpoints para criação, atualização, exclusão e consulta de notas, aqui chamadas de grades.

DETALHES DO FUNCIONAMENTO DA API:

As grades deverão ser salvas em um arquivo json, chamado grades.json.
Esse arquivo será previamente fornecido e seus endpoints devem atuar considerando os registros já existentes.
Uma grade deve possuir os campos abaixo:
  • id : identificador único da grade. Deve ser gerado automaticamente pela API e garantir que não se repita.

  • student : nome do aluno. Exemplo: Guilherme Assis.

  • subject : nome da matéria. Exemplo: Matemática.

  • type : nome da atividade. Exemplo: Prova final.

  • value : nota da atividade. Exemplo: 10.

  • timestamp : horário do lançamento. Exemplo: 2020-05-19T18:21:24.964Z.

O arquivo grades.json será previamente fornecido com alguns registros inseridos. Seus endpoints devem trabalhar considerando a existência deles, não devendo criar um arquivo limpo para utilização.

A propriedade nextId deve armazenar sempre o próximo id que será utilizado na criação de uma nova grade. A propriedade grades possui um array com várias grades. Cada uma é representada por um objeto com os campos descritos anteriormente.

DESCRIÇÃO DOS ENDPOINTS:

Os endpoints foram desenvolvidos conforme as descrições abaixo:

1 - Crie um endpoint para criar uma grade. Este endpoint deverá receber como parâmetros os campos student, subject, type e value conforme descritos acima. Essa grade deverá ser salva no arquivo json grades.json, e deverá ter um id único associado. No campo timestamp deverá ser salvo a data e hora do momento da inserção. O endpoint deverá retornar o objeto da grade que foi criada. A API deverá garantir o incremento automático desse identificador, de forma que ele não se repita entre os registros. Dentro do arquivo grades.json que foi fornecido para utilização no desafio, o campo nextId já está com um valor definido. Após a inserção é preciso que esse nextId seja incrementado e salvo no próprio arquivo, de forma que na próxima inserção ele possa ser utilizado. 2 - Crie um endpoint para atualizar uma grade. Esse endpoint deverá receber como parâmetros o id da grade a ser alterada e os campos student, subject, type e value. O endpoint deverá validar se a grade informada existe, caso não exista deverá retornar um erro. Caso exista, o endpoint deverá atualizar as informações recebidas por parâmetros no registro, e realizar sua atualização com os novos dados alterados no arquivo grades.json. 3 - Crie um endpoint para excluir uma grade. Esse endpoint deverá receber como parâmetro o id da grade e realizar sua exclusão do arquivo grades.json. 4 - Crie um endpoint para consultar uma grade em específico. Esse endpoint deverá receber como parâmetro o id da grade e retornar suas informações. 5 - Crie um endpoint para consultar a nota total de um aluno em uma disciplina. O endpoint deverá receber como parâmetro o student e o subject, e realizar a soma de todas as notas de atividades correspondentes àquele subject, para aquele student. O endpoint deverá retornar a soma da propriedade value dos registros encontrados. 6 - Crie um endpoint para consultar a média das grades de determinado subject e type. O endpoint deverá receber como parâmetro um subject e um type, e retornar a média. A média é calculada somando o registro value de todos os registros que possuem o subject e type informados, dividindo pelo total de registros que possuem este mesmo subject e type. 7 - Crie um endpoint para retornar as três melhores grades de acordo com determinado subject e type. O endpoint deve receber como parâmetro um subject e um type, e retornar um array com os três registros de maior value daquele subject e type. A ordem deve ser do maior para o menor.

About

API para controle de grades escolares, utilizando conceito de Rotas e a biblioteca winston para arquivos de log

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published