cristianoans/node-express

Documentação da API de Usuários

Esta é a documentação da API de Usuários. Aqui você encontrará informações sobre os endpoints disponíveis e como utilizá-los.

Endpoint /usuarios

Este endpoint permite listar, criar, atualizar e deletar usuários.

GET /usuarios

Este endpoint retorna uma lista de usuários com base nos parâmetros de consulta, caso nenhum seja informado, retorna a lista completa.

Parâmetros de consulta

• 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.

Respostas

• 200 OK: Retorna a lista de usuários.
• 400 Bad Request: Parâmetros inválidos.
• 500 Internal Server Error: Erro interno do servidor.

POST /usuarios

Este endpoint permite criar um novo usuário no sistema.

Corpo da requisição

Deve ser enviado um objeto JSON com as informações do novo usuário.

jsonCopy code
{
  "matricula": "string",
  "nome": "string",
  "nota1": 0,
  "nota2": 0
}

Respostas

• 201 Created: Usuário criado com sucesso.
• 400 Bad Request: Parâmetros inválidos.
• 500 Internal Server Error: Erro interno do servidor.

PUT /usuarios

Este endpoint permite atualizar as informações de um usuário existente no sistema.

Corpo da requisição

Deve ser enviado um objeto JSON com as informações atualizadas do usuário.

jsonCopy code
{
  "matricula": "string",
  "nome": "string",
  "nota1": 0,
  "nota2": 0
}

Respostas

• 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.

DELETE /usuarios

Este endpoint permite deletar um usuário existente no sistema.

Corpo da requisição

Deve ser enviado um objeto JSON com o ID do usuário a ser deletado.

jsonCopy code
{
  "id": 0
}

Respostas

• 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.

Esquema de dados

O esquema de dados utilizado pela API é descrito a seguir:

User

• 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).