Seja bem vindo(a) ao desafio do módulo 5.
Sua tarefa como desenvolvedor(a) será criar uma API para um PDV (Frente de Caixa). Esse será um projeto piloto, ou seja, no futuro outras funcionalidades serão implementadas.
Importante 1: Sempre que a validação de uma requisição falhar, responda com código de erro e mensagem adequada à situação, ok?
Importante 2: Para endpoints de cadastro/atualização os objetos de requisição devem conter as propriedades equivalentes as colunas das tabelas.
Exemplo:
// Corpo da requisição para cadastro de usuário (body)
{
"nome": "José",
"email": "jose@email.com",
"senha": "jose"
}ATENÇÃO: Todos os endpoints deverão atender os requisitos citados acima.
Você precisa criar um Banco de Dados PostgreSQL chamado pdv.
IMPORTANTE: Deverá ser criado no projeto o arquivo SQL que deverá ser o script contendo os comandos de criação das tabelas respeitando os nomes das tabelas e colunas respectivamente, além de, conter os comandos para a inserção das categorias que devem ser previamente cadastradas (estão citadas na 1ª Sprint no item Listar Categorias).
- A API a ser criada deverá acessar o banco de dados a ser criado
pdvpara persistir e manipular os dados de categorias, clientes, pedidos, produtos e usuários utilizados pela aplicação. - O campo id das tabelas no banco de dados deve ser auto incremento, chave primária e não deve permitir edição uma vez criado.
- Qualquer valor monetário deverá ser representado em centavos (Ex.: R$ 10,00 reais = 1000)
Abaixo, listamos os possíveis status codes esperados como resposta da API.
// 200 (OK) = requisição bem sucedida
// 201 (Created) = requisição bem sucedida e algo foi criado
// 204 (No Content) = requisição bem sucedida, sem conteúdo no corpo da resposta
// 400 (Bad Request) = o servidor não entendeu a requisição pois está com uma sintaxe/formato inválido
// 401 (Unauthorized) = o usuário não está autenticado (logado)
// 403 (Forbidden) = o usuário não tem permissão de acessar o recurso solicitado
// 404 (Not Found) = o servidor não pode encontrar o recurso solicitado
// 500 (Internal Server Error) = erro inesperado do servidor1ª Sprint
Banco de Dados
Crie as seguintes tabelas e colunas abaixo:
ATENÇÃO! Os nomes das tabelas e das colunas a serem criados devem seguir exatamente os nomes listados abaixo.
- usuarios
- id
- nome
- email (campo único)
- senha
- categorias
- id
- descricao
Listar categorias
Essa é a rota que será chamada quando o usuário quiser listar todas as categorias cadastradas.
As categorias a seguir precisam ser previamente cadastradas para que sejam listadas no endpoint de listagem das categorias.
- Informática
- Celulares
- Beleza e Perfumaria
- Mercado
- Livros e Papelaria
- Brinquedos
- Moda
- Bebê
- Games
Cadastrar usuário
Essa é a rota que será utilizada para cadastrar um novo usuário no sistema.
Critérios de aceite:
- Validar os campos obrigatórios:
- nome
- email
- senha
- A senha deve ser criptografada utilizando algum algoritmo de criptografia confiável.
- O campo e-mail no banco de dados deve ser único para cada registro, não permitindo dois usuários possuírem o mesmo e-mail.
Efetuar login do usuário
Essa é a rota que permite o usuário cadastrado realizar o login no sistema.
Critérios de aceite:
- Validar se o e-mail e a senha estão corretos para o usuário em questão.
- Gerar um token de autenticação para o usuário.
ATENÇÃO: Todas as funcionalidades (endpoints) a seguir, a partir desse ponto, deverão exigir o token de autenticação do usuário logado, recebendo no header com o formato Bearer Token. Portanto, em cada funcionalidade será necessário validar o token informado.
Detalhar perfil do usuário logado
Essa é a rota que permite o usuário logado a visualizar os dados do seu próprio perfil, de acordo com a validação do token de autenticação.
Editar perfil do usuário logado
Essa é a rota que permite o usuário logado atualizar informações de seu próprio cadastro, de acordo com a validação do token de autenticação.
Critérios de aceite:
- Validar os campos obrigatórios:
- nome
- email
- senha
- A senha deve ser criptografada utilizando algum algoritmo de criptografia confiável.
- O campo e-mail no banco de dados deve ser único para cada registro, não permitindo dois usuários possuírem o mesmo e-mail.
Efetuar deploy da aplicação
Fazer deploy do projeto e disponibilizar a URL.
2ª Sprint
Banco de Dados
Crie as seguintes tabelas e colunas abaixo:
ATENÇÃO! Os nomes das tabelas e das colunas a serem criados devem seguir exatamente os nomes listados abaixo.
- produtos
- id
- descricao
- quantidade_estoque
- valor
- categoria_id
- clientes
- id
- nome
- email (campo único)
- cpf (campo único)
- cep
- rua
- numero
- bairro
- cidade
- estado
ATENÇÃO: Todas as funcionalidades (endpoints) a seguir, a partir desse ponto, deverão exigir o token de autenticação do usuário logado, recebendo no header com o formato Bearer Token. Portanto, em cada funcionalidade será necessário validar o token informado.
Cadastrar Produto
Essa é a rota que permite o usuário logado cadastrar um novo produto no sistema.
Critérios de aceite:
- Validar os campos obrigatórios:
- descricao
- quantidade_estoque
- valor
- categoria_id
- A categoria informada na qual o produto será vinculado deverá existir.
Editar dados do produto
Essa é a rota que permite o usuário logado a atualizar as informações de um produto cadastrado.
Critérios de aceite:
- Validar se existe produto para o id enviado como parâmetro na rota.
- Validar os campos obrigatórios:
- descricao
- quantidade_estoque
- valor
- categoria_id
- A categoria informada na qual o produto será vinculado deverá existir.
Listar Produtos
Essa é a rota que será chamada quando o usuário logado quiser listar todos os produtos cadastrados.
Deveremos incluir um parâmetro do tipo query categoria_id para que seja possível consultar produtos por categorias, de modo, que serão filtrados de acordo com o id de uma categoria.
Critérios de aceite:
- Caso seja enviado o parâmetro do tipo query **categoria_id**, filtrar os produtos de acordo com a categoria, caso o id de categoria informada exista.
- Caso não seja informado o parâmetro do tipo query **categoria_id** todos os produtos cadastrados deverão ser retornados.
Detalhar Produto
Essa é a rota que permite o usuário logado obter um de seus produtos cadastrados.
Critérios de aceite:
- Validar se existe produto para o id enviado como parâmetro na rota.
Excluir Produto por ID
Essa é a rota que será chamada quando o usuário logado quiser excluir um de seus produtos cadastrados.
Critérios de aceite:
- Validar se existe produto para o id enviado como parâmetro na rota.
Cadastrar Cliente
Essa é a rota que permite usuário logado cadastrar um novo cliente no sistema.
Critérios de aceite:
- Validar os campos obrigatórios:
- nome
- email
- cpf
- O campo e-mail no banco de dados deve ser único para cada registro, não permitindo dois clientes possuírem o mesmo e-mail.
- O campo cpf no banco de dados deve ser único para cada registro, não permitindo dois clientes possuírem o mesmo cpf.
Editar dados do cliente
Essa é a rota que permite o usuário realizar atualização de um cliente cadastrado.
Critérios de aceite:
- Validar se existe cliente para o id enviado como parâmetro na rota.
- Validar os campos obrigatórios:
- nome
- email
- cpf
- O campo e-mail no banco de dados deve ser único para cada registro, não permitindo dois clientes possuírem o mesmo e-mail.
- O campo cpf no banco de dados deve ser único para cada registro, não permitindo dois clientes possuírem o mesmo cpf.
Listar Clientes
Essa é a rota que será chamada quando o usuário logado quiser listar todos os clientes cadastrados.
3ª Sprint
Banco de Dados
Crie as seguintes tabelas e colunas abaixo:
ATENÇÃO! Os nomes das tabelas e das colunas a serem criados devem seguir exatamente os nomes listados abaixo.
- pedidos
- id
- cliente_id
- observacao
- valor_total
- pedido_produtos
- id
- pedido_id
- produto_id
- quantidade_produto
- valor_produto
- produtos
- produto_imagem
ATENÇÃO: Todas as funcionalidades (endpoints) a seguir, a partir desse ponto, deverão exigir o token de autenticação do usuário logado, recebendo no header com o formato Bearer Token. Portanto, em cada funcionalidade será necessário validar o token informado.
Cadastrar Pedido
Essa é a rota que será utilizada para cadastrar um novo pedido no sistema.
Lembre-se: Cada pedido deverá conter ao menos um produto vinculado.
Atenção: As propriedades produto_id e quantidade_produto devem ser informadas dentro de um array e para cada produto deverá ser criado um objeto neste array, como ilustrado no objeto de requisição abaixo. Só deverá ser cadastrado o pedido caso todos produtos vinculados ao pedido realmente existão no banco de dados.
// Corpo da requisição para cadastro de pedido (body)
{
"cliente_id": 1,
"observacao": "Em caso de ausência recomendo deixar com algum vizinho",
"pedido_produtos": [
{
"produto_id": 1,
"quantidade_produto": 10
},
{
"produto_id": 2,
"quantidade_produto": 20
}
]
}Critérios de aceite:
- Validar os campos obrigatórios:
- cliente_id
- pedido_produtos
- produto_id
- quantidade_produto
- Validar se existe cliente para o id enviado no corpo (body) da requisição.
- Validar se existe produto para cada produto_id informado dentro do array enviado no corpo (body) da requisição.
- Validar se existe a quantidade em estoque de cada produto existente dentro do array, de acordo com a quantidade informada no corpo (body) da requisição.
- O pedido deverá ser cadastrado, apenas, se todos os produtos estiverem validados.
- Enviar e-mail para o cliente notificando que o pedido foi efetuado com sucesso.
Listar Pedidos
Essa é a rota que será chamada quando o usuário logado quiser listar todos os pedidos cadastrados.
Deveremos incluir um parâmetro do tipo query cliente_id para que seja possível consultar pedidos por clientes, de modo, que serão filtrados de acordo com o id de um cliente.
// Resposta para listagem de pedido (body)
[
{
"pedido": {
"id": 1,
"valor_total": 230010,
"observacao": null,
"cliente_id": 1
},
"pedido_produtos": [
{
"id": 1,
"quantidade_produto": 1,
"valor_produto": 10,
"pedido_id": 1,
"produto_id": 1
},
{
"id": 2,
"quantidade_produto": 2,
"valor_produto": 230000,
"pedido_id": 1,
"produto_id": 2
}
]
}
]Critérios de aceite:
- Caso seja enviado o parâmetro do tipo query **cliente_id**, filtrar os pedidos de acordo com o cliente, caso o id do cliente informado exista.
- Caso não seja informado o parâmetro do tipo query **cliente_id** todos os pedidos cadastrados deverão ser retornados.
Aplicar validação na exclusão de produto
Deverá ser aplicada uma regra de negócio que não permitirá exclusão de produto que tenha sido registrado em algum pedido.
Critérios de aceite:
- Validar se o produto que está sendo excluído não está vinculado a nenhum pedido, caso estiver, não poderá ser excluído e deverá ser retornada uma mensagem indicando o motivo.
Aprimorar cadastro/atualização de produto
Deverão ser aprimorados o cadastro e a atualização de produto para permitir vincular uma imagem a um produto.
Deverá ser criada uma coluna produto_imagem para que seja possível efetuar o vínculo entre a imagem e o produto.
Critérios de aceite:
- O campo `produto_imagem` deve ser opcional, mas, em caso de ser enviado no corpo da requisição deveremos processar a imagem vinculada a essa propriedade e armazenar a imagem em um servidor de armazenamento (Supabase, Blackblaze, etc...)
- Armazenar na coluna `produto_imagem` a URL que possibilita visualizar a imagem que foi efetuada upload para o servidor de armazenamento.
Lembre-se: A URL retornada deve ser válida, ou seja, ao ser clicada deve possibilitar visualizar a imagem que foi feito upload.
ATENÇÃO: Abaixo segue o exemplo de uma URL fictícia, mas que no caso, ilustra o que o serviço de armazenamento do Blackblaze retornaria após upload efetuado com sucesso, portanto essa seria no caso a URL que armazaremos na coluna produto_imagem no banco de dados.
// Resposta cadastro/atualização de produto (body)
{
"descricao": "Motorola moto g9 plus",
"quantidade_estoque": 100,
"valor": 15000,
"categoria_id": 2,
"produto_imagem": "https://s3.us-east-005.backblazeb2.com/desafio-final.jpg"
}Aprimorar exclusão de produto
Deverá ser aprimorada a exclusão de produto para que quando o produto for excluído também seja removida a imagem vinculada a ele na servidor de armazenamento.
Critérios de aceite:
- Na exclusão do produto a imagem vinculada a este produto deverá ser excluída do servidor de armazenamento.