felipesantosdd / merit_back

API de Tarefas e Usuários

A API fornecida apresenta endpoints para a gestão de tarefas (To-Do) e usuários, com funcionalidades de autenticação. Abaixo, detalhamos cada endpoint disponibilizado pelos serviços oferecidos:

Tarefas (To-Do)

1. Criação de Nova Tarefa

• Endpoint: POST /todos

• Descrição: Cria uma nova tarefa associada a um usuário.

• Parâmetros de Requisição:

  • newTodoData: Objeto contendo informações da nova tarefa.
    • title: Título da tarefa.
    • text: Descrição da tarefa.

• Exemplo de Requisição:

  POST /todos
  Authorization: Bearer <token_de_acesso>
  
  {
    "newTodoData": {
      "title": "Completar Projeto",
      "text": "Concluir a implementação do novo projeto"
    }
  }

• Possíveis Respostas:

  • 201 Created: Tarefa criada com sucesso.
  • 409 Conflict: Nome da tarefa já utilizado.

2. Listagem de Todas as Tarefas

• Endpoint: GET /todos
• Descrição: Retorna a lista de todas as tarefas criadas pelo usuário logado.
• Parâmetros de Requisição:
  • Nenhum.
• Exemplo de Requisição:

  GET /todos
  Authorization: Bearer <token_de_acesso>

• Possíveis Respostas:
  • 200 OK: Lista de tarefas recuperada com sucesso.

3. Detalhes de uma Tarefa Específica

• Endpoint: GET /todos/:id
• Descrição: Retorna detalhes de uma tarefa específica.
• Parâmetros de Requisição:
  • id: Identificador único da tarefa.
• Exemplo de Requisição:

  GET /todos/976f4e05-088a-4cd1-ac72-48777f52537
  Authorization: Bearer <token_de_acesso>

• Possíveis Respostas:
  • 200 OK: Detalhes da tarefa recuperados com sucesso.
  • 401 Unauthorized: Não autorizado.
  • 404 Not Found: Tarefa não encontrada.

4. Atualização de uma Tarefa Específica

• Endpoint: PATCH /todos/:id

• Descrição: Atualiza parcialmente uma tarefa específica, alterando propriedades fornecidas (com exceção do id).

• Parâmetros de Requisição:

  • id: Identificador único da tarefa.
  • todoUpdate: Objeto contendo as propriedades a serem atualizadas na tarefa.

• Exemplo de Requisição:

  PATCH /todos/976f4e05-088a-4cd1-ac72-48777f52537
  Authorization: Bearer <token_de_acesso>
  
  {
    "todoUpdate": {
      "text": "Concluir a implementação e testes"
    }
  }

• Possíveis Respostas:

  • 200 OK: Tarefa atualizada com sucesso.
  • 401 Unauthorized: Não autorizado.
  • 404 Not Found: Tarefa não encontrada.

5. Remoção de uma Tarefa Específica

• Endpoint: DELETE /todos/:id
• Descrição: Remove uma tarefa específica.
• Parâmetros de Requisição:
  • id: Identificador único da tarefa.
• Exemplo de Requisição:

  DELETE /todos/976f4e05-088a-4cd1-ac72-48777f52537
  Authorization: Bearer <token_de_acesso>

• Possíveis Respostas:
  • 204 No Content: Tarefa removida com sucesso.
  • 401 Unauthorized: Não autorizado a remover a tarefa.
  • 404 Not Found: Tarefa não encontrada.

Usuários

1. Cadastro de Novo Usuário

• Endpoint: POST /users

• Descrição: Cria um novo usuário.

• Parâmetros de Requisição:

  • newUserData: Objeto contendo informações do novo usuário.
    • nome: Nome do usuário.
    • email: Endereço de e-mail do usuário.
    • senha: Senha do usuário.

• Exemplo de Requisição:

  POST /users
  
  {
    "newUserData": {
      "nome": "John Doe",
      "email": "[email protected]",
      "senha": "senha123"
    }
  }

• Possíveis Respostas:

  • 200 OK: Usuário criado com sucesso.
  • 409 Conflict: E-mail já está sendo usado.

2. Listagem de Todos os Usuários

• Endpoint: GET /users
• Descrição: Retorna a lista de todos os usuários cadastrados.
• Parâmetros de Requisição: Nenhum.
• Exemplo de Requisição:

  GET /users

• Possíveis Respostas:
  • 200 OK: Lista de usuários recuperada com sucesso.
  • 404 Not Found: Nenhum usuário cadastrado.

3. Detalhes de um Usuário Específico

• Endpoint: GET /users/:id
• Descrição: Retorna detalhes de um usuário específico, excluindo informações sensíveis.
• **Par

âmetros de Requisição:** - id: Identificador único do usuário.

• Exemplo de Requisição:

  GET /users/1

• Possíveis Respostas:
  • 200 OK: Detalhes do usuário recuperados com sucesso.
  • 404 Not Found: Usuário não encontrado.

4. Autenticação de Usuário

• Endpoint: POST /users/login

• Descrição: Autentica um usuário existente.

• Parâmetros de Requisição:

  • data: Objeto contendo informações de login.
    • email: Endereço de e-mail do usuário.
    • senha: Senha do usuário.

• Exemplo de Requisição:

  POST /users/login
  
  {
    "data": {
      "email": "[email protected]",
      "senha": "senha123"
    }
  }

• Possíveis Respostas:

• 200 OK: Login bem-sucedido. Retorna informações do usuário e um token de acesso.

• 401 Unauthorized: Usuário e/ou senha inválidos.

Notas Gerais

• Todos os identificadores (id) são do tipo UUID.

• O token de acesso deve ser incluído no cabeçalho de autorização (Authorization: Bearer <token_de_acesso>) para autenticação em endpoints protegidos.

• Nenhum usuário pode alterar, deletar ou sequer buscar os dados de outros usuários.

• O arquivo .env conta com as variáveis de ambiente Docker.

• Esta aplicação conta com testes automatizados. Para executar os testes, navegue ate a pasta Back com cd Back, altere a variável de ambiente ENVIRONMENT para test instale as dependencias com npm i e execute o comando npm run test. Para acessar testes específicos, você pode executar npm run test com o caminho do teste, por exemplo: npm run test users/create. Isso executará apenas os testes desejados.

• Para a execução da aplicação, entre na pasta Docker e execute o comando docker-compose up na raiz do projeto e aguarde o início da aplicação,por padrao a api ira estar na porta 3001.