Esta é a documentação da API de Usuários. Aqui você encontrará informações sobre os endpoints disponíveis e como utilizá-los.
Este endpoint permite listar, criar, atualizar e deletar usuários.
Este endpoint retorna uma lista de usuários com base nos parâmetros de consulta, caso nenhum seja informado, retorna a lista completa.
matricula
(string): Matrícula do usuário.nome
(string): Nome completo do usuário.media
(number): Média mínima das notas.aprovado
(boolean): Indica se o usuário foi aprovado ou não.
200 OK
: Retorna a lista de usuários.400 Bad Request
: Parâmetros inválidos.500 Internal Server Error
: Erro interno do servidor.
Este endpoint permite criar um novo usuário no sistema.
Deve ser enviado um objeto JSON com as informações do novo usuário.
jsonCopy code{ "matricula": "string", "nome": "string", "nota1": 0, "nota2": 0 }
201 Created
: Usuário criado com sucesso.400 Bad Request
: Parâmetros inválidos.500 Internal Server Error
: Erro interno do servidor.
Este endpoint permite atualizar as informações de um usuário existente no sistema.
Deve ser enviado um objeto JSON com as informações atualizadas do usuário.
jsonCopy code{ "matricula": "string", "nome": "string", "nota1": 0, "nota2": 0 }
200 OK
: Usuário atualizado com sucesso.400 Bad Request
: Parâmetros inválidos.404 Not Found
: Usuário não encontrado.500 Internal Server Error
: Erro interno do servidor.
Este endpoint permite deletar um usuário existente no sistema.
Deve ser enviado um objeto JSON com o ID do usuário a ser deletado.
jsonCopy code{ "id": 0 }
204 No Content
: Usuário deletado com sucesso.400 Bad Request
: Parâmetros inválidos.404 Not Found
: Usuário não encontrado.500 Internal Server Error
: Erro interno do servidor.
O esquema de dados utilizado pela API é descrito a seguir:
id
(integer): Identificador único do usuário, gerado automaticamente pelo banco de dados.matricula
(string): Matrícula do usuário.nomecompleto
(string): Nome completo do usuário.nota1
(number): Nota da primeira avaliação.nota2
(number): Nota da segunda avaliação.media
(number): Média das notas, calculado automaticamente com base nas notas informadas.aprovado
(boolean): Indica se o usuário foi aprovado ou não, calculado automaticamente com base na média (>=8).