Este projeto trata-se de uma aplicação que se assemelha ao dia a dia da XP, um aplicativo de investimento em ações, com algumas funcionalidades de conta digital.
-
Decidi utilizar o TypeScript para facilitar a detecção de erros durante o desenvolvimento e pelo IntelliSense do VS Code, que reflete maior agilidade e segurança ao escrever o código.
-
Adotei a arquitetura de camadas MSC(Model, Service e controller) que ficaram responsaveis por realizar queries no banco de dados, tratamento de regras de negócio e interação com API, respectivamente.
-
O banco de dados escolhido foi o MYSQL, realizando a conexão com a camada Model por meio da biblioteca mysql2 do Express.
-
Geri meu tempo para poder pensar bem na API e consegui implementá-la junto com o requisito bonus da autenticação com token JWT.
-
Procurei utilizar verbos HTTP adequados para cada operação, e corrigi algumas URLs conforme a seção de contratos abaixo no README.
-
A requisição GET escolhida para a listagem dos ativos investidos foi o endpoint de caminho (/ativos/{cod-cliente}), correpondente à tabela ativos-cliente, cuja quantia é atualizada a cada solicitação de investimento.
Tabelas
O banco possui sete tabelas: pessoas clientes, ativos-corretora, ativos-cliente, ordens de compra, ordens de venda, depositos e saques.
DROP DATABASE IF EXISTS desafio_xp;
CREATE DATABASE desafio_xp;
USE desafio_xp;
CREATE TABLE pessoa_cliente (
codCliente INTEGER PRIMARY KEY NOT NULL,
username TEXT NOT NULL,
password TEXT NOT NULL,
saldo DOUBLE NOT NULL
) ENGINE=INNODB;
CREATE TABLE ordens_de_compra (
codCliente INTEGER NOT NULL,
codAtivo INT NOT NULL,
qtdeAtivo INT NOT NULL
) ENGINE=INNODB;
CREATE TABLE ordens_de_venda (
id INTEGER AUTO_INCREMENT PRIMARY KEY NOT NULL,
codCliente INTEGER NOT NULL,
codAtivo INT NOT NULL,
qtdeAtivo INT NOT NULL
) ENGINE=INNODB;
CREATE TABLE depositos (
id INTEGER AUTO_INCREMENT PRIMARY KEY NOT NULL,
codCliente INTEGER NOT NULL,
valor DOUBLE NOT NULL
) ENGINE=INNODB;
CREATE TABLE saques (
id INTEGER AUTO_INCREMENT PRIMARY KEY NOT NULL,
codCliente INTEGER NOT NULL,
valor DOUBLE NOT NULL
) ENGINE=INNODB;
CREATE TABLE ativos_corretora (
codAtivo INTEGER AUTO_INCREMENT PRIMARY KEY NOT NULL,
ticker VARCHAR(5) NOT NULL,
qtdeAtivo INTEGER NOT NULL,
valor DOUBLE NOT NULL
) ENGINE=INNODB;
CREATE TABLE ativos_cliente (
id INTEGER AUTO_INCREMENT PRIMARY KEY NOT NULL,
codCliente INTEGER NOT NULL,
codAtivo INTEGER NOT NULL,
qtdeAtivo INTEGER NOT NULL,
valor DOUBLE NOT NULL
) ENGINE=INNODB;
INSERT INTO
desafio_xp.ativos_corretora (codAtivo, ticker, qtdeAtivo, valor)
VALUES
(1, "PETR4", 1000000, 29.18);
INSERT INTO
desafio_xp.ativos_corretora (codAtivo, ticker, qtdeAtivo, valor)
VALUES
(2, "VALE3", 50000, 68.88);
INSERT INTO
desafio_xp.ativos_corretora (codAtivo, ticker, qtdeAtivo, valor)
VALUES
(3, "ABEV3", 2500000, 14.48);
INSERT INTO
desafio_xp.ativos_corretora (codAtivo, ticker, qtdeAtivo, valor)
VALUES
(4, "ITUB4", 100000, 23.62);
INSERT INTO
desafio_xp.ativos_corretora (codAtivo, ticker, qtdeAtivo, valor)
VALUES
(5, "BBDC3", 500000, 14.33);O arquivo desafio_xp.sql contém as queries que criam e populam o banco.
NodeJS, ExpressJS, MYSQL, TypeScript, Git e ES6.
Backend
cd desafio-xp/
npm installnode instalado em seu computador.
-
Para rodar o back-end:
cd desafio-xp/ && npm run dev
- O endpoint pode ser acessado através do caminho (
/investimentos/comprar) e recebe como entrada o seguinte body:
{
"codCliente": "integer",
"codAtivo": "integer",
"qtdeAtivo": "integer",
}Retorno
- Caso a quantidade de ativos deja maior que a disponível na corretora será retornado o seguinte JSON com Status HTTP 400:
{
"message": "Quantidade indisponível na Corretora!"
}- Havendo sucesso na requisição a ordem é adicionada à tabela ordens de compra, e a quantia de ativos comprada é atualizada em ativos-cliente retornando Status HTTP 201 Created e a ordem:
{
"codCliente": 1,
"codAtivo": 3,
"qtdeAtivo": 300,
"id": 0
}- Esta rota teve o caminho
/clienteadicionado para não haver conflito com a rota Get By Asset dos ativos da corretora; - Endpoint(
/ativos/cliente/{cod-cliente}) que recebe como parametro o codigo do cliente cadastrado. - Implementei esta rota para que fosse capaz de enviar os ativos sob custódia de cada cliente para o Front-end.
Retorno:
- Caso o cod-cliente estiver cadastrado e com ativos sob custódia ela retorna status 200 OK com a lista dos ativos com os dados codigo do cliente, código do ativo, quantidade investida e valor unitario do ativo, respectivamente:
[
{
"codCliente": 1,
"codAtivo": 4,
"qtdeAtivo": 4000,
"valor": 23.62
},
{
"codCliente": 1,
"codAtivo": 5,
"qtdeAtivo": 5000,
"valor": 14.33
},
{
"codCliente": 1,
"codAtivo": 2,
"qtdeAtivo": 3000,
"valor": 68.88
},
{
"codCliente": 1,
"codAtivo": 1,
"qtdeAtivo": 500,
"valor": 29.18
},
{
"codCliente": 1,
"codAtivo": 3,
"qtdeAtivo": 300,
"valor": 14.48
}
]- Endpoint(
/ativos/{cod-ativo}) que recebe como parametro o codigo do ativo cadastrado na tabela.
Retorno
- Caso o cod-ativo corresponder aos ativos disponíveis retorna status 200 OK e o objeto do ativo com o código, quantidade disponível para compra e valor unitario, respectivamente:
{
"codAtivo": 5,
"qtdeAtivo": 5000000,
"valor": 14.33
}
- O endpoint pode é acessado no caminho (
/conta/deposito) e recebe como entrada o seguinte body:
{
"codCliente": "integer",
"valor": "integer",
}Retorno
- Caso o valor na requisição for negativo ou zero será retornado Status HTTP 400 com a mensagem:
{
"message": "Quantidade a ser depositada não poderá ser negativa ou igual a zero."
}- Havendo sucesso na requisição o depósito é adicionada à tabela ordens de depósito, retornando Status HTTP 201 Created e a ordem:
{
"codCliente": 1,
"valor": 1000,
"id": 2
}- O endpoint pode é acessado no caminho (
/conta/saque) e recebe como entrada o seguinte body:
{
"codCliente": "integer",
"valor": "integer",
}Retorno
- Caso o valor na requisição de saque for negativo, igual a zero, ou maior que a quantidade disponível no saldo será retornado Status HTTP 400 com a mensagem:
{
"message": "Quantidade a ser sacada não poderá ser maior que o saldo, negativa ou igual a zero."
}- Havendo sucesso na requisição o depósito é adicionada à tabela ordens de saque, retornando Status HTTP 201 Created e a ordem:
{
"codCliente": 1,
"valor": 100,
"id": 1
}- Endpoint(
/conta/{cod-ativo}) que recebe como parametro o codigo do cliente cadastrado na corretora.
Retorno
- Caso o codigo corresponder a um cliente cadastrado, retorna status 200 OK e o objeto do ativo com o código e saldo disponível na conta deste cliente:
{
"codCliente": 1,
"saldo": 1000
}
- O endpoint pode é acessado na URL (
/login) e recebe como entrada o seguinte body com um middleware de validação:
{
"username": "string",
"password": "string",
}Retorno
- Caso não possua username ou password, retorna Status HTTP 400 e respectivas mensagens:
{
"message": "\"username\" is required"
} {
"message": "\"password\" is required"
}- Havendo sucesso na requisição, retorna-se o token com Status HTTP 201 Created:
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7InVzZXJuYW1lIjoiYWxpY2UifSwiaWF0IjoxNjU4NzExOTg0LCJleHAiOjE2NTg3MTI4ODR9.MgMbDqpCN4a42szDtgWLo3gTxpU0vFPskhGm1E8XA44"
}