Para a implementação deste projeto vamo precisar usar as seguintes tecnologias:
- Node.js para fornecer a possibilidade de executar JS em um servidor
- Express.js para criar rotas de api
- Dotenv para criarmos configurações com mais facilidade e segurança
- Nodemon para termos mais produtividade em nosso ambiente de desenvolvimento
- Supabase para persistência de dados
- Sequelize para termos mais produtividade ao lidar com o banco de dados
- JWT para adicionar segurança e limitar o acesso nas rotas de API
- Cloundinary para guardar imagem enviada pelo usuário e transforma em url para o banco
- Bcryptjs criptografa as senhas para o banco
backend-to-do-list/
├── src/
│ ├── config/
│ ├── controllers/
│ ├── middleware/
│ ├── models/
│ ├── routes/
│ ├── app.js
├── .env
├── .gitignore
└── package.json
- 200 OK
- Indica que a API REST executou com êxito qualquer ação solicitada pelo cliente
- Ao contrário do código de status 204, uma 200 deve incluir um corpo de resposta
- 201 CREATED
- Indica que a requisição foi bem sucedida e que um novo recurso foi criado
- 204 No content
- O código de status 204 geralmente é enviado em resposta a uma solicitação PUT ou DELETE quando a API se recusa a retornar qualquer corpo de mensagem no response
- A resposta 204 NÃO DEVE incluir um corpo de mensagem
- 400 Bad Request
- Indica que o servidor não pode ou não irá processar a requisição devido a alguma coisa que foi entendida como um erro do cliente
- 401 Unauthorized
- Indica que a solicitação não foi aplicada porque não possui credenciais de autenticação válidas para o recurso de destino
- 404 Not Found
- Indica que o servidor não conseguiu encontrar o recurso solicitado
Requisito 01 - Criar a tabela de User
O objetivo deste requisito é criar a tabela de usuários no banco de dados utilizando o Sequelize ORM. A tabela deve conter as colunas a seguir:
- id: Coluna do tipo INTEGER que representa a chave primária da tabela. Seu valor deve ser incrementado automaticamente pelo banco de dados
- firstName: Coluna do tipo STRING e de preenchimento obrigatório que armazena o primeiro nome do usuário
- lastName: Coluna do tipo STRING e de preenchimento obrigatório que armazena o sobrenome do usuário.
- email: Coluna do tipo STRING e de preenchimento obrigatório que armazena o endereço de email do usuário
- password: Coluna do tipo STRING e de preenchimento obrigatório que armazena a senha do usuário. O valor a ser armazenado deve ser o hash da senha gerado pelo pacote bcrypt.
- profilePic: Coluna do tipo String e de preenchimento opcional.
Use a configuração
timestamps: truedo sequelize para gerar as colunas created_at e updated_at
Requisito 02 - Criar a tabela de Task
O objetivo deste requisito é criar a tabela de Tarefas no banco de dados utilizando o Sequelize ORM. A tabela deve conter as colunas a seguir:
- id: Coluna do tipo INTEGER que representa a chave primária da tabela. Seu valor deve ser incrementado automaticamente pelo banco de dados
- userId: Coluna do tipo INTEGER que representa a chave estrangeira da tabela User. Referencia ao id do usuário
- title: Coluna do tipo STRING e de preenchimento obrigatório que armazena o nome da tarefa.
- description: Coluna do tipo STRING, e de preenchimento obrigatório que armazena a descrição da tarefa.
- favorite: Coluna do tipo BOOLEAN e de preenchimento opcional que define se a tarefa é favorita. Valor padrão deve ser False.
- progress: Coluna do tipo FLOAT e de preenchimento opcional que define o progresso da tarefa. Valor padrão deve ser 0.
- finishDate: Coluna do tipo DATE e de preenchimento opcional que define a data que a tafera foi finalizada.
Use a configuração
timestamps: truedo sequelize para gerar as colunas created_at e updated_at
Requisito 03 - Criar a tabela de TaskItem
O objetivo deste requisito é criar a tabela de itens dentro da tabela de tarefas no banco de dados utilizando o Sequelize ORM. A tabela deve conter as colunas a seguir:
- id: Coluna do tipo INTEGER que representa a chave primária da tabela. Seu valor deve ser incrementado automaticamente pelo banco de dados
- status: Coluna do tipo BOOLEAN e de preenchimento opcional que define se o item foi concluido(true) ou não(false). Valor padrão deve ser False.
- title: Coluna do tipo STRING e de preenchimento obrigatório que armazena o titulo do item.
- taskId: Coluna do tipo INTEGER que representa a chave estrangeira da tabela Task. Referencia ao id de task.
Use a configuração
timestamps: truedo sequelize para gerar as colunas created_at e updated_at
Requisito 01 - Criar endpoint para obter informações do usuário pelo ID
- GET /v1/user/:id
Response body
{
"id": 1,
"firstName": "a",
"lastName": "b",
"email": "[email protected]",
"password": "$2a$10$mAgzk3Vd1Ucz50HzUEmTJu0UQOk.nLSmIh/LRBc010nmLmIKw8I92",
"profilePic": "https://res.cloudinary.com/dajvgprkmf.jpg",
"updatedAt": "2024-09-10T03:54:55.811Z",
"createdAt": "2024-09-10T03:54:55.811Z"
}Response Status Code
- 200 OK - Deve ser retornado quando a requisição foi bem sucedida
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 02 - Criar endpoint de cadastro de usuário
- POST /v1/user
Headers
- Content-type: application/json
Payload
{
"firstName": "asd",
"lastName": "asd",
"email": "[email protected]",
"password": "123456",
"profilePic": "url da imagem",
}Response Status Code
- 201 Created - Deve ser retornado quando o cadastro for bem sucedido
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
Requisito 03 - Criar endpoint atualizar usuário
- PUT /v1/user/:id
Headers
- Content-type: application/json
Payload
{
"firstName": "dc",
"lastName": "cd",
"email": "[email protected]",
"password": "12",
"profilePic": "https://res.cloudinary.com/dajvgprso/image/upload/v1725940495/profile_pics/xikpyjcnwawbbelhokmf.jpg",
} Response Status Code
- 204 No Content - Deve ser retornado quando a requisição foi bem sucedida mas nenhum corpo deve ser retornado.
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 04 - Criar endpoint de deletar usuário
- DELETE /v1/user/:id
Headers
- Content-type: application/json
Response Status Code
- 204 No Content - Deve ser retornado quando a requisição foi bem sucedida mas nenhum corpo deve ser retornado.
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 01 - Criar endpoint para obter uma lista de Tarefas referente ao usuário
- GET /v1/task/all/:id
Response body
[
{
"id": 2,
"title": "Estudar",
"description": "asdasdasd",
"finishDate": "2024-12-31T00:00:00.000Z",
"progress": 100,
"userId": 3,
"favorite": false,
"createdAt": "2024-09-08T20:28:55.510Z",
"updatedAt": "2024-09-09T18:07:32.386Z",
"TaskItems": [
{
"id": 3,
"title": "Assistir vídeo aula 1",
"status": true,
"taskId": 2,
"createdAt": "2024-09-08T20:28:56.177Z",
"updatedAt": "2024-09-08T20:28:56.177Z"
},
{
"id": 4,
"title": "Praticar exercícios",
"status": true,
"taskId": 2,
"createdAt": "2024-09-08T20:28:56.177Z",
"updatedAt": "2024-09-09T04:48:33.922Z"
}
]
},
{
"id": 3,
"title": "Programar",
"description": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaasdasd",
"finishDate": "2024-12-31T00:00:00.000Z",
"progress": 100,
"userId": 3,
"favorite": false,
"createdAt": "2024-09-08T20:29:30.257Z",
"updatedAt": "2024-09-09T18:07:32.185Z",
"TaskItems": [
{
"id": 12,
"title": "kotlin",
"status": true,
"taskId": 3,
"createdAt": "2024-09-09T05:11:09.677Z",
"updatedAt": "2024-09-09T05:11:09.677Z"
},
{
"id": 5,
"title": "java",
"status": true,
"taskId": 3,
"createdAt": "2024-09-08T20:29:30.915Z",
"updatedAt": "2024-09-09T05:12:36.251Z"
},
{
"id": 6,
"title": "python",
"status": true,
"taskId": 3,
"createdAt": "2024-09-08T20:29:30.915Z",
"updatedAt": "2024-09-09T05:12:44.721Z"
}
]
},
]Response Status Code
- 200 OK - Deve ser retornado quando a requisição foi bem sucedida
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
Requisito 02 - Criar endpoint para obter informações de somente uma tarefa
- GET /v1/task/:taskId
Response body
{
"id": 6,
"title": "asdddddddd",
"description": "dassssssssssssssssssssssss as dasdas asdonaoisdn",
"finishDate": null,
"progress": 20,
"userId": 3,
"favorite": false,
"createdAt": "2024-09-08T23:04:51.593Z",
"updatedAt": "2024-09-09T18:07:32.096Z",
"TaskItems": [
{
"id": 14,
"title": "3",
"status": false,
"taskId": 6,
"createdAt": "2024-09-09T05:30:54.898Z",
"updatedAt": "2024-09-09T05:30:54.898Z"
},
{
"id": 15,
"title": "4",
"status": false,
"taskId": 6,
"createdAt": "2024-09-09T05:30:55.044Z",
"updatedAt": "2024-09-09T05:30:55.044Z"
},
]
} Response Status Code
- 200 OK - Deve ser retornado quando a requisição foi bem sucedida
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 03 - Criar endpoint de cadastro de tarefas
- POST /v1/task
Headers
- Content-type: application/json
Payload
{
"title": "ar",
"description": "aaaaaaaaaaaaaasdasd",
"userId": 3,
"taskItems": [
{
"title": "java"
},
{
"title": "python"
}
]
}
Response Status Code
- 201 Created - Deve ser retornado quando o cadastro for bem sucedido
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
Requisito 04 - Criar endpoint de atualização de tarefas
- PUT /v1/task/:id
Headers
- Content-type: application/json
Payload
{
"title": "ar",
"description": "aaaaaaaaaaaaaasdasd",
"finishDate": "2024-12-31T00:00:00.000Z",
"progress": 20,
"favorite": false,
"taskItems": [
{
"title": "java"
},]
}Response Status Code
- 204 No Content - Deve ser retornado quando a requisição foi bem sucedida mas nenhum corpo deve ser retornado.
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 05 - Criar endpoint de deletar tarefa
- DELETE /v1/task/:id
Headers
- Content-type: application/json
Response Status Code
- 204 No Content - Deve ser retornado quando a requisição foi bem sucedida mas nenhum corpo deve ser retornado.
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 06 - Criar endpoint para obter tarefa favoritas
- GET /v1/task/favorite/:userId
Response body
{
"id": 6,
"title": "asdddddddd",
"description": "dassssssssssssssssssssssss as dasdas asdonaoisdn",
"finishDate": null,
"progress": 20,
"userId": 3,
"favorite": true,
"createdAt": "2024-09-08T23:04:51.593Z",
"updatedAt": "2024-09-09T18:07:32.096Z",
"TaskItems": [
{
"id": 14,
"title": "3",
"status": false,
"taskId": 6,
"createdAt": "2024-09-09T05:30:54.898Z",
"updatedAt": "2024-09-09T05:30:54.898Z"
},
{
"id": 15,
"title": "4",
"status": false,
"taskId": 6,
"createdAt": "2024-09-09T05:30:55.044Z",
"updatedAt": "2024-09-09T05:30:55.044Z"
},
]
} Response Status Code
- 200 OK - Deve ser retornado quando a requisição foi bem sucedida
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 07 - Criar endpoint de deletar itens de uma tarefa
- DELETE /v1/tasks/:taskId/items/:id
Headers
- Content-type: application/json
Response Status Code
- 204 No Content - Deve ser retornado quando a requisição foi bem sucedida mas nenhum corpo deve ser retornado.
- 401 Unauthorized - Deve ser retornado quando o token de autorização não for enviado ou estiver incorreto
- 404 Not Found - Deve ser retornado quando o recurso solicitado não existe
Requisito 01 - Criar endpoint de geração do token JWT
- POST /v1/user/token
Headers
- Content-type: application/json
Payload
{
"email": "[email protected]",
"password": "123@123",
} Response body
{
"token": "<JWT>",
} Response Status Code
- 200 OK - Deve ser retornado quando a requisição foi bem sucedida
- 400 Bad Request - Deve ser retornado quando a os dados da requisição estiverem incorretos
Requisito 02 - Validar token nos métodos POST, PUT e DELETE
Todos os endpoints POST, PUT e DELETE devem conter o cabeçalho Authorization: Bearer <jwt>, caso contrario a requisição
deve ser rejeitada com o status code 400 Bad Request