Skip to content

ergonzamarian/API-Banco-Digital

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API-Banco-Digital 💰

Nesta API encontrará as funções essenciais relacionadas ao gerenciamento de contas bancárias

Navegue pelo sumário abaixo

InicioPré Requisitos (Instalação)Como Executar o projetoTestar no SwaggerTestar no PostmanTecnologiasAutor


  • O teste da API pode ser feito pelo Swagger ou Postman • Sugestão do autor: Swagger

Inicio

🚀 Regra de negócio

  • Para abrir uma conta é necessário apenas o nome completo e CPF da pessoa, mas só é permitido uma conta por pessoa
  • Com essa conta é possível realizar transferências para outras contas e depositar
  • Não aceitamos valores negativos nas contas
  • Por questão de segurança cada transação de depósito não pode ser maior do que R$2.000
  • Este Projeto foi Documentado com Swagger para facilitar os testes

Pré-requisitos

🔧 Instalação e configuração

⚠️ As ferramentas informadas aqui foram as que eu utilizei, fique a vontade para escolher a que for mais familiar a você.

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Você também precisará fazer a seguinte configuração (siga o caminho abaixo)

  • Clique com o botão direito em "Meu Computador";
  • Clique em "Propriedades";
  • Clique em "Configurações Avançadas do Sistema";
  • Clique em "Variáveis de Ambiente";
  • Copie o caminho para onde você fez o download do JDK 17.0.1;
  • Em "Variáveis de Ambiente>Variáveis do Sistema" clique em "novo" e insira o nome da variável como sendo "JAVA_HOME" e insira o caminho do JDK 17.0.1 que você copiou e clique em "OK";
  • Ainda em "Variáveis de Ambiente>Variáveis do Sistema" clique em "novo" e insira o nome da variável como sendo "CLASSPATH" e no valor coloque um ponto "." e depois clique em "OK";
  • Em "Variáveis do Sistema" localize o "Path" e dê um duplo clique sobre ele, e adicione "%JAVA_HOME%\bin" e mova-o para cima e depois clique em "OK" e novamente em "OK";
  • Para validar a instalação do JDK abra o cmd e digite "java -version" e aparecerá a versão do java instalado.

Como Executar o projeto

⚙️ Executando e Instalando as Dependências

# Clone este repositório
$ git clone https://github.com/ergonlima/API-Banco-Digital/tree/main/desafio-rest-api
  • Abra o IntelliJ IDEA Community Edition que você instalou e depois abra o projeto;
  • Localize na parte direita superior lateral uma aba chamada "Maven" e a abra;
  • Clique em "Reload All Maven Projects" para sincronizar e baixar as dependências do Maven;
  • Após isso, basta clicar na seta verde ou apertar "shift+F10" e a API já estará executando.

Testar no Swagger

📝 Siga todos os Passos para realizar os testes

-Todas as Mensagens de Exceção são exibidas no log da IDE

Cole no seu navegador o link abaixo ou Clique Aqui

# http://localhost:8080/swagger-ui/#/conta-bancaria-controller

A tela abaixo será apresentada

1_swagger

Função Busca por Id

-Antes de inserir o Parâmetro solicitado, sempre aperte em "Try it out" EM TODOS OS MÉTODOS

2_swagger

-Depois insira o id e clique em "Execute", O resultado será exibido abaixo em forma de JSON

3_swagger

Função Busca Todos

-Clique em "Execute", O resultado será exibido abaixo em forma de JSON

4_swagger

Função Cadastrar Conta

-Insira o CPF e o nome do Cliente do Banco, não é possível inserir dois usuários com o mesmo CPF, cumprindo assim a regra de não cadastrar a mesma pessoa duas vezes

-Depois Clique em "Execute" e o usuário estará cadastrado se retornar status 200 OK

5_swagger

Função Deletar Conta

-Insira o Id e Clique em "Execute", após isso a conta será excluída"

6_swagger

Função Depositar na Conta através do Id

-Insira o Id da conta que deseja depositar o dinheiro e depois informe o valor e Clique em "Execute", após isso o dinheiro será depositado, é possível ver o resultado usando a função de busca por Id

-Só é possível realizar depósitos entre R$ 0,00 e R$ 2000,00

7_swagger

Função Trasferência entre duas contas informando idDestino, idOrigem e Valor da transferência

-Insira o Id de quem receberá o dinheiro (idDestino)

-Insira o Id de quem Enviará o dinheiro (idOrigem)

-Insira o Valor da Transferência

Só é possível realizar transferências entre R$ 0,00 e R$ 2000,00 e o cliente não pode enviar valores a mais do que possui

8_swagger

Testar no Postman

📝 Siga todos os Passos para realizar os testes

-Todas as Mensagens de Exceção são exibidas no log da IDE

# Clone este repositório da collection do Postman
$ https://github.com/ergonlima/API-Banco-Digital/tree/main/collection-postman

Após isso, importe o arquivo .json para o Postman

A collection ficará assim

9_postman

Função Cadastrar Conta

-Insira o CPF e o nome do Cliente do Banco, não é possível inserir dois usuários com o mesmo CPF, cumprindo assim a regra de não cadastrar a mesma pessoa duas vezes

-Depois Clique em "Send" e o usuário estará cadastrado se retornar status 200 OK

10_postman

Função Busca por Id

-Insira o id na url e clique em "Send", O resultado será exibido abaixo em forma de JSON

11_postman

Função Depositar na Conta através do Id

-Insira o Id da conta que deseja depositar o dinheiro e depois informe o valor e Clique em "Send", após isso o dinheiro será depositado, é possível ver o resultado usando a função de busca por Id

-Só é possível realizar depósitos entre R$ 0,00 e R$ 2000,00

12_postman

Função Trasferência entre duas contas informando idDestino, idOrigem e Valor da transferência

-Insira o Id de quem receberá o dinheiro (idDestino)

-Insira o Id de quem Enviará o dinheiro (idOrigem)

-Insira o Valor da Transferência

Só é possível realizar transferências entre R$ 0,00 e R$ 2000,00 e o cliente não pode enviar valores a mais do que possui

13_postman

Função Deletar Conta

-Insira o Id e Clique em "Send", após isso a conta será excluída"

14_postman

Função Busca Todos

-Clique em "Send", O resultado será exibido abaixo em forma de JSON

15_postman

Tecnologias

🛠️ Ferramentas

As seguintes ferramentas foram usadas na construção do projeto:


Autor

Made by Ergon Zamarian Lima 👋😁

About

Projeto Finalizado :: API desenvolvida e documentada com Swagger

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages