Boas vindas ao repositório do Desafio Técnico de Backend da Turma XP - Trybe 🚀

O que foi desenvolvido 👩‍💻

Uma API que simula o funcionamento de uma corretora, utilizando Node.JS e a arquitetura MSC (Models, Service e Controllers).

Desenvolvimento 🎯

Na aplicação desenvolvida é possível ler, escrever ou atualizar informações sobre compra e venda de ações, carteira de ações do cliente, código e valor de um ativo, depositar e sacar da conta do cliente e solicitar o saldo disponível da conta do cliente. Todas as informações estão em um banco de dados, que foi desenvolvido e manipulado utilizando o MySQL.

Tecnologias utilizadas 🛠

Instalando depedências 🔽

  cd psel-turma-XP

  npm install

Executando a aplicação 🖥

  cd psel-turma-XP

  docker-compose up -d

O comando irá inicializar um container chamado XP_Investimentos e outro chamado XP_Investimentos_db

  docker exec -it XP_Investimentos bash

  npm install

  npm run debug

Gerar o BD XPInvestimentos via workbench com sql script com as credenciais do .env

Fazer as requisições nas rotas

Executando os testes unitários 🧪

  cd psel-turma-XP

  npm run test:mocha

Documentação da API 📒

Documentação escrita seguindo o modelo disponibilizado em README.so

Gera o token JWT

  POST /conta/login

Parâmetros	Tipo	Descrição
`emailCliente` e `senhaCliente`	`string`	Obrigatórios. Informações de login da conta do cliente

Teste: Realize requisições com algum dos seguintes usuários:

{
  "emailCliente": "[email protected]",
  "senhaCliente": "senha123"
}

{
  "emailCliente": "[email protected]",
  "senhaCliente": "senha123"
}

{
  "emailCliente": "[email protected]",
  "senhaCliente": "senha123"
}

Deposito na conta do cliente

  POST /conta/deposito

Parâmetros	Tipo	Descrição
`codCliente` e `valor`	`string`	Obrigatórios. Informações de deposito na conta do cliente

Teste: Realize requisições com o codCliente: 1, codCliente: 2 ou codCliente: 3 e valor opcional:

{
  "codCliente": "1",
  "valor": "50"
}

{
  "codCliente": "2",
  "valor": "100"
}

{
  "codCliente": "3",
  "valor": "150"
}

Saque na conta do cliente

  POST /conta/saque

Parâmetros	Tipo	Descrição
`codCliente` e `valor`	`string`	Obrigatórios. Informações de saque na conta do cliente

Teste: Realize requisições com codCliente: 1, codCliente: 2 ou codCliente: 3 e valor opcional:

{
  "codCliente": "1",
  "valor": "10"
}

{
  "codCliente": "2",
  "valor": "15"
}

{
  "codCliente": "3",
  "valor": "20"
}

Saldo disponível na conta do cliente

  GET /conta/${codCliente}

Parâmetro	Tipo	Descrição
`codCliente`	`string`	Obrigatório. Id do cliente

Teste: Realize requisições com o codCliente: 1, codCliente: 2 ou codCliente: 3

Informações da carteira do cliente

  GET /conta/cliente/${codCliente}

Parâmetros	Tipo	Descrição
`codCliente`	`string`	Obrigatório. Id do cliente

Teste: Realize requisições com o codCliente: 1, codCliente: 2 ou codCliente: 3

Quantidade de ativo na carteira do cliente

  POST /conta/carteira/${codCliente}

Parâmetros	Tipo	Descrição
`codCliente` e `codAtivo`	`string`	Obrigatórios. Informação da carteira do cliente

Teste: Realize requisições com codCliente: 1, codCliente: 2 ou codCliente: 3; e codAtivo: 1, codAtivo: 2 ou codAtivo: 3:

{
  "codCliente": "1"
}

{
  "codCliente": "2"
}

{
  "codCliente": "3"
}

Compra de ativo

  POST /investimentos/comprar

Parâmetros	Tipo	Descrição
`codCliente`, `codAtivo` e `qtdeAtivo`	`string`	Obrigatórios. Informações para compra de ativo

Teste: Realize requisições com codCliente: 1, codCliente: 2 ou codCliente: 3; codAtivo: 1, codAtivo: 2 ou codAtivo: 3 e qtdeAtivo opcional:

{
    "codCliente": "1",
    "codAtivo": "1",
    "qtdeAtivo": "3"
}

{
    "codCliente": "2",
    "codAtivo": "2",
    "qtdeAtivo": "6"
}

{
    "codCliente": "3",
    "codAtivo": "3",
    "qtdeAtivo": "9"
}

Venda de ativo

  POST /investimentos/vender

Parâmetros	Tipo	Descrição
`codCliente`, `codAtivo` e `qtdeAtivo`	`string`	Obrigatórios. Informações para venda de ativo

Teste: Realize requisições com codCliente: 1, codCliente: 2 ou codCliente: 3; codAtivo: 1, codAtivo: 2 ou codAtivo: 3 e qtdeAtivo opcional:

{
    "codCliente": "1",
    "codAtivo": "1",
    "qtdeAtivo": "2"
}

{
    "codCliente": "2",
    "codAtivo": "2",
    "qtdeAtivo": "4"
}

{
    "codCliente": "3",
    "codAtivo": "3",
    "qtdeAtivo": "8"
}

Quantidade de ativo na corretora

  GET /ativos/quantidade/${codAtivo}

Parâmetros	Tipo	Descrição
`codAtivo`	`string`	Obrigatório. Id do ativo

Teste: Realize requisições com o codAtivo: 1, codAtivo: 2 ou codAtivo: 3

Informações do ativo na corretora

  GET /ativos/${codAtivo}

Parâmetros	Tipo	Descrição
`codAtivo`	`string`	Obrigatório. Id do ativo

Teste: Realize requisições com o codAtivo: 1, codAtivo: 2 ou codAtivo: 3

Minhas considerações durante o desenvolvimento 📝

Rodar a aplicação: 📌

Solução para o erro: "unknown database"

Passei cerca de 3 horas com esse erro, alterei dados da conexão, substituindo o acesso ao .env por a string equivalente; Excluí os containers algumas vezes e rodei o docker-compose up -d para gera-los novamente porém não resolveu.

Focando em continuar o desenvolvimento do desafio técnico encontrei uma solução na segunda resposta dessa pergunta do Stack Overflow (referente a os dois ultimos passos da seção executando a aplicação).

Diagrama do banco de dados: 🎲

Gerei o diagrama do banco de dados em Diagrams.net

kecbm / api-finance Goto Github PK

api-finance's Introduction