EquipControl - Server

Projeto Integrador 5º Semestre ADS - 2023
Status do projeto: Finalizado

Esse repositório é destinado ao armazenamento do backend desenvolvido para o projeto EquipControl .

Documentação API

Documentação dos métodos de autenticação, listagem de equipamentos e realização de manobras para um determinado equipamento.

Rota: /auth/login

• Método: POST
• Descrição: Rota de autenticação, utilizada para obter um token de autenticação.
• Parâmetros de entrada:
  • username (string): Nome de usuário do usuário.
  • password (string): Senha do usuário.
• Exemplo de Requisição:

  {
    "username": "usuario123",
    "password": "senha@123"
  }

• Resposta de Sucesso (200):
  • token (string): Token de autenticação válido.
  • user (object): Usuário autenticado.
• Respostas de Erro:
  • 401 Unauthorized: Falha na autenticação.
  • 422 Unprocessable Entity: Parâmetros inválidos ou incompletos.
  • 500 Internal Server Error: Erro de comunicação com o servidor.

Rota: /equipment/get

• Método: GET
• Descrição: Rota para listar todos os equipamentos cadastrados.
• Headers:

  Authorization: Bearer <token>.
  

• Resposta de Sucesso (200):
  • equipments (array): Lista (array) com todos os equipamentos cadastrados e suas propriedades.
• Respostas de Erro:
  • 401 Unauthorized: Não autenticado.
  • 500 Internal Server Error: Erro de comunicação com o servidor.

Rota: /equipment/updateStatus/:id

• Método: PATCH
• Descrição: Rota para listar todos os equipamentos cadastrados.
• Headers:

  Authorization: Bearer <token>.
  

• Parâmetros de entrada:
  • id (string): Id (_id) do equipamento. (query)
  • isActive (boolean): Novo status para o equipamento. (body)
• Exemplo de Requisição:

  {
    "isActive": false
  }

• Resposta de Sucesso (201):
  • equipment (object): Equipamento atualizado.
• Respostas de Erro:
  • 400 Bad Request: Parâmetros inválidos ou incompletos.
  • 401 Unauthorized: Não autenticado.
  • 404 Not Found: Equipamento não encontrado.
  • 422 Unprocessable Entity: Parâmetros inválidos ou incompletos.
  • 500 Internal Server Error: Erro de comunicação com o servidor.

🛠️ Tecnologias

Tecnologias utilizadas para o desenvolvimento desse backend do projeto:

👩‍💻 Equipe

Função	Nome	GitHub	LinkedIn
Scrum Master	Eduardo Pereira Carvalho
Product Owner	Thales de Lucca Kerber
Developer	Lucas Nunes Duarte do Nascimento
Developer	Victoria Marto Dias

→ Voltar ao topo