Ignite - Trilha NodJS - Chapter I - Desafio 01 - Todos

Sobre o desafio

Nesse desafio, você deverá criar uma aplicação para treinar o que aprendeu até agora no Node.js!

Requisitos do Projeto

Essa será uma aplicação para gerenciar tarefas (em inglês todos).  Será permitida a criação de um usuário com name e username, bem como fazer o CRUD de todos:

• Criar um novo todo;
• Listar todos os todos;
• Alterar o title e deadline de um todo existente;
• Marcar um todo como feito;
• Excluir um todo;

Tudo isso para cada usuário em específico (o username será passado pelo header).

Requisitos

• Deve ser possível criar um novo usuário;
• Deve ser possível criar um novo todo;
• Deve ser possível listar os todos;
• Deve ser possível alterar o title e deadline de um todo existente;
• Deve ser possível marcar um todo como feito;
• Deve ser possível deletar um todo;

Requisitos Adicionais

• Deve ser possível listar os usuarios cadastrados;

Regras de Negócio

• Não deve ser possível cadastrar um usuário com o mesmo username;
• Não deve ser possível cadastrar um todo para um usuário inexistente;
• Não deve ser possível listar os todos de um usuário inexistente;
• Não deve ser possível alterar o title e deadline de um todo inexistente;
• Não deve ser possível marcar um todo inexistente como feito;
• Não deve ser possível deletar um todo inexistente;

Rotas da API

Detalhamento das rotas da API

USERS

Gerênciamento de usuários

Rota: /users

Método	Rota	Descrição
POST	http://{apiBaseUrl}/users	Cria um novo usuário
GET	http://{apiBaseUrl}/users	Lista todos os usuários

Modelo do JSON de entrada

Json para criação de um novo usuário

{ 
    "name": "Nome Completo do Usuário", 
    "username": "login de acesso"
}

Modelo do JSON de saída

Json retornado após a criação de um novo usuário

{
    "id": "ad1a5496-361e-4462-9c67-180ce22e0807",
    "name": "Nome Completo do Usuário",
    "username": "login de acesso",
    "todos": []
}

TODOS

Gerênciamento de tarefas

Rota: /todos

Método	Rota	Descrição
POST	http://{apiBaseUrl}/todos	Cria um novo todo
GET	http://{apiBaseUrl}/todos	Lista todos os todos
PUT	http://{apiBaseUrl}/todos/:id	Altera o title e o deadline de um todo
PATCH	http://{apiBaseUrl}/todos/:id/done	Altera o status de um todo para done
DELETE	http://{apiBaseUrl}/todos/:id	Deleta um todo

Modelo do JSON de entrada

Json para criação de uma nova tarefa "TODO"

{ 
    "title": "Nome da tarefa"
}

Modelo do JSON de saída

Json retornado após a criação de uma nova tarefa "TODO"

{
    "id": "fcfe9ff4-bc61-4127-a761-69edb64ff047",
    "title": "Nome da tarefa",
    "done": false,
    "deadline": null,
    "created_at": "2022-10-24T16:15:28.749Z"
}

Executando o projeto

Iniciar o repositório do Exemplo

# Baixar as dependências
npm install

Iniciar o servidor

# Executar o servidor
npm run dev

Executar os testes

# Executar os testes
npm run test