Neste projeto foi desenvolvida uma API RESTful utilizando a arquitetura MSC e o banco de dados MySql.
A API trata-se de um sistema de gerenciamento de vendas, onde é possível criar, visualizar, deletar e atualizar produtos e vendas.
Desenvolvido usando: Javascript, Express, Node.js, Mysql, Mocha, Chai, Sinon
Instale as dependências do projeto:
npm installPara que o projeto funcione corretamente será necessário criar um arquivo do tipo .env com as variáveis de ambiente referentes ao banco de dados e portas a serem utilizadas. Por exemplo, caso o seu usuário SQL seja nome e a senha 1234 seu arquivo .env ficará desta forma:
MYSQL_HOST=localhost
MYSQL_USER=nome
MYSQL_PASSWORD=1234
PORT=3000Logo em seguida será necessário criar o banco de dados e as tabelas que vão compor o banco. Na raiz do projeto existe o arquivo StoreManager.sql, nele estão todas as queries necessárias para criar o banco e as tabelas. Basta executar o arquivo em alguma interface de MySql, como por exemplo a MySQL Workbench, ou copiar, colar e executar as queries dentro da interface SQL:
DROP DATABASE IF EXISTS StoreManager;
CREATE DATABASE StoreManager;
USE StoreManager;
CREATE TABLE products (
id INT NOT NULL auto_increment,
name VARCHAR(30) NOT NULL,
quantity INT NOT NULL,
PRIMARY KEY(id)
) ENGINE=INNODB;
CREATE TABLE sales (
id INT NOT NULL auto_increment,
date DATETIME DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY(id)
) ENGINE=INNODB;
CREATE TABLE sales_products (
sale_id INT NOT NULL,
product_id INT NOT NULL,
quantity INT NOT NULL,
FOREIGN KEY (sale_id)
REFERENCES sales (id)
ON DELETE CASCADE,
FOREIGN KEY (product_id)
REFERENCES products (id)
ON DELETE CASCADE
) ENGINE=INNODB;
SET SQL_SAFE_UPDATES = 0;O banco possui três tabelas: products, sales e sales_products.
A tabela products tem o seguinte formato:
A tabela sales tem o seguinte formato:
A tabela sales_products, é a tabela que faz o relacionamento N:N entre products e sales e tem o seguinte formato:
Para executar a aplicação normalmente:
npm startPara executar em modo de desenvolvimento, com a ferramenta Nodemon, onde a cada vez que um arquivo é alterado, o servidor é reiniciado automaticamente, assim, não há a necessidade de utilizar o npm start a cada alteração feita nos arquivos.
npm run debugA API possui até o momento somente testes unitários para a camada Model, para rodar os testes basta executar o comando abaixo:
npm testRota responsável por cadastrar novos produtos na tabela products. o body da requisição deve ter o seguinte formato:
{
"name": "produto",
"quantity": 10
}Exemplo de retorno com sucesso:
{
"id": 1
"name": "produto",
"quantity": 10
}- Atributos
nameequantitynão podem estar vazios; - Atributo
namenão pode ter menos de 5 caracteres; - Não será possível cadastrar um produto com o mesmo nome de um já cadastrado no banco;
- Atributo
quantitydeve ser igual ou maior que1.
Rota responsável por listar todos os produtos cadastrados na tabela products.
Exemplo de retorno com sucesso:
[
{
"id": 1,
"name": "produto A",
"quantity": 10
},
{
"id": 2,
"name": "produto B",
"quantity": 20
}
]Rota responsável por listar o produto especificado pelo id passado na rota.
Exemplo de retorno com sucesso:
{
"id": 1,
"name": "produto A",
"quantity": 10
}Quando o id do produto não é encontrado:
{ "message": "Product not found" }Rota responsável por atualizar os dados de um produto específico na tabela products. O id do produto deve ser passado na rota, e o body da requisição deve ter o seguinte formato:
{
"name": "new_product_name",
"quantity": 20
}Exemplo de retorno com sucesso:
{
"id": 1
"name": "new_product_name",
"quantity": 20
}Quando o id do produto não é encontrado:
{ "message": "Product not found" }- Atributos
nameequantitynão podem estar vazios; - Atributo
namenão pode ter menos de 5 caracteres; - Atributo
quantitydeve ser igual ou maior que1.
Rota responsável por remover um produto da tabela products com base no id passado na requisição.
Exemplo de retorno com sucesso:
{
"id": 1,
"name": "produto A",
"quantity": 10
}Quando o id do produto a ser deletado não é encontrado:
{ "message": "Product not found" }Rota responsável por cadastrar novos produtos na tabela sales. o body da requisição deve ter o seguinte formato:
[
{
"product_id": 1,
"quantity": 5,
}
]Exemplo de retorno com sucesso:
{
"id": 1,
"itemsSold": [
{
"product_id": 1,
"quantity": 5
}
]
}Também é possível cadastrar múltiplas vendas com uma requisição, exemplo com a venda de dois produtos:
[
{
"product_id": 1,
"quantity": 2
},
{
"product_id": 2,
"quantity": 5
}
]Retorno do banco após o cadastro da venda de dois produtos:
{
"id": 1,
"itemsSold": [
{
"product_id": 1,
"quantity": 2
},
{
"product_id": 2,
"quantity": 5
}
]
}- Atributos
product_idequantitynão podem estar vazios; - Atributo
quantitydeve ser igual ou maior que1.
Rota responsável por listar todas as vendas cadastradas na tabela sales.
Exemplo de retorno com sucesso:
[
{
"saleId": 1,
"date": "2021-09-09T04:54:29.000Z",
"product_id": 1,
"quantity": 2
},
{
"saleId": 2,
"date": "2021-09-09T04:54:54.000Z",
"product_id": 2,
"quantity": 2
}
]Rota responsável por listar uma venda especificada pelo id passado na rota.
Exemplo de retorno de uma venda com múltiplos produtos:
[
{
"date": "2021-09-09T04:54:29.000Z",
"product_id": 1,
"quantity": 2
},
{
"date": "2021-09-09T04:54:54.000Z",
"product_id": 2,
"quantity": 2
}
]Quando o id da venda não é encontrado:
{ "message": "Sale not found" }Rota responsável por atualizar os dados de uma venda específica na tabela sales. O id da venda deve ser passada na rota, e o body da requisição deve ter o seguinte formato:
[
{
"product_id": 3,
"quantity": 30
}
]Exemplo de retorno com sucesso:
{
"saleId": 1,
"itemUpdated": [
{
"product_id": 3,
"quantity": 30
}
]
}Quando o id da venda não é encontrado:
{ "message": "Sale not found" }- Atributos
product_idequantitynão podem estar vazios; - Atributo
quantitydeve ser igual ou maior que1.
Rota responsável por remover uma venda da tabela sales com base no id passado na requisição.
Exemplo de retorno com sucesso:
[
{
"date": "2021-09-09T04:54:29.000Z",
"product_id": 1,
"quantity": 2
},
{
"date": "2021-09-09T04:54:54.000Z",
"product_id": 2,
"quantity": 2
}
]Quando o id da venda a ser deletada não é encontrado:
{ "message": "Sale not found" }