API-Corretora de investimentos

Contexto

Simulação de uma api para um app de investimentos, no qual é possivel comprar/vender investimentos, sacar/depositar dinheiro na conta do usuário e buscar dados sobre ativos.

A Api foi construída no modelo MSC(model, service e controller). Sendo a model responsável pelo BD, service para as regras de negócio, e controller para lidar com as requisições e respostas.

A Api possui autenticação JWT em todas as rotas exceto a de login. Nas rotas críticas além da validação do token, ainda há uma validação para ver se o usuário logado através do token é o mesmo que está fazendo a requisição (a validação só possivel através de uma consulta ao BD)

Também foram realizados testes unitários com Mocha Chai e Sinon.

Foi realizado um deploy da aplicação no heroku e o link se encontra no canto superior direto, você pode testar as requisições através do link do deploy, do Swagger ou rodando a aplicação na sua máquina após fazer um clone.

Habilidades desenvolvidas durante o desenvolvimento da API

• 🔥 Organizar uma aplicação completa desde o primeiro passo; 🔥
• Estruturar uma aplicação em camadas;
• Delegar responsabilidades específicas para cada camada;
• Melhorar a reusabilidade do código;
• Entender e aplicar os padrões REST;
• Escrever assinaturas para APIs intuitivas e facilmente entendíveis;
• 🔥 Documentar aplicação com o Swagger; 🔥
• Utilizar JWT para autenticação;
• Configurar docker-compose;
• Utilizar Dotenv para as variáveis de ambiente secretas.;
• Utilizar Joi para tratamento de erros com tradução para o pt-br;
• 🔥 Fazer deploy de uma aplicação backEnd com banco de dados na nuvem através heroku; 🔥
• Realizar testes unitários tentando buscar cobertura de 100% do código.

Tecnologias utilizadas

• JavaScrip
• Mocha
• Sinon
• Node.js
• Swagger
• JWT
• Chai
• Joi
• Express.js
• Dotenv
• Mysql

Endpoints disponíveis na aplicação:

Disponíveis para serem testados, e com mais especificações no link do Swagger abaixo:

https://app.swaggerhub.com/apis-docs/Alineol/xp_api1/1.0.0

Como rodar o projeto na sua máquina:

🐳 Rodando no Docker vs Localmente

Com Docker

Rode os containers com o comando docker-compose up -d.

• Esse serviço irá inicializar dois containers chamados xp_api(node, port:3000) e xp_api_db(mysql, port 3308).
• A partir daqui você pode rodar o container via CLI ou abri-lo no VS Code.

Use o comando docker exec -it xp_api bash.

• Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.

Instale as dependências com npm install

• Não é necessário editar o aquivo .env.example, o docker-compose já está com as variáveis de ambiente.

Para iniciar a aplicação: npm start

• Todos os comandos npm devem ser rodados dentro do container, exceto npm commit (caso queira usar o commitizem)

Sem Docker

Instale as dependências com npm install

• Para a aplicação funcionar corretamente você precisa editar o arquivo ./.env.example:
  • alterar as variáveis de ambiente com o seu nome de usuário e senha.
  • mudar o nome do aquivo para .env, caso contrário a aplicação não encontrará o arquivo.

👀 De olho nas dicas:

1. Para rodar o projeto desta forma, obrigatóriamente você deve ter o node instalado em seu computador.

Para iniciar a aplicação: npm start

AVISOS MEGA IMPORTANTES!

Para você conseguir testar as rotas através da sua máquina é necessário que você popule o banco do dados:

• Se estiver usando o docker, você precisa criar um novo usuário com os dados disponíveis nas váriaveis de ambiente do compose.

• Após acessar o Mysql, copie a query para criar o banco de dados disponível na aquivo ./XPCorretora.sql e execute-a no sql.

• Se NÃO estiver usando o docker, acesse o mysql com os mesmos dados que você inseriu no .env.example e popule o banco com a mesma query.

Informações sobre o Banco de Dados

A imagem acima exemplifica o banco de dados e as relações entre as tabelas

• A Tabela ativosCorretora possui todos os ativos da corretora;
• A tabela usuarios possui dados sobre os clientes;
• A tabela contas possui dados sobre a conta dos usuários;
• A tabela AtivosUsuarios possui dados sobre quais usuários tem tal ativo;
  • Essa tabela possui uma relação de N:N com as outras duas tabelas, nesse caso, um mesmo ativo pode pertencer à varios usuários, e um usuário pode ter vários ativos, por isso a chave primária dessa tabela é o código do cliente e o código do ativo.

Informações sobre teste

Nessa aplicação foram realizados apenas testes unitários. Para rodar os testes localmente não é necessário que a aplicação esteja iniciada.

No terminal digite npm run test

• Esse comando iniciará os testes

No terminal digite npm run coverage

• Esse comando iniciará os testes e no final apresentará um relatório de cobertura dos testes.

Validações e ações das rotas:

/login

• validação do body
• validação das informações no BD

/cliente/conta/:CodCliente

• validação do header
• validação se o token corresponse ao id enviado no parâmetro

/cliente/conta/saque

• validação do body
• validação se o token corresponse ao id enviado no body
• confere se o valor para saque não é maior que o disponível na conta

/cliente/conta/deposito

• validação do body
• validação se o token corresponse ao id enviado no body

/cliente/ativos:codCliente

• validação do header
• confere se o id do token é do conrresponde ao login

/ativos

• validação se tem token

/ativos/:codAtivo

• validação se tem token

/investimentos/vender

• validação do body
• validação se o token corresponse ao id enviado no body
• validação do id do ativo
• adiciona o valor da venda na conta do cliente

/investimentos/comprar

• validação do body
• validação se o token corresponse ao id enviado no body
• validação do id do ativo
• confere se o cliente possui saldo para a compra
• retira o valor da comprana conta do cliente

/admin/usuarios

• retorna todos os usuários
• não tem verificação