Skip to content

Latest commit

 

History

History
125 lines (90 loc) · 4.8 KB

README.md

File metadata and controls

125 lines (90 loc) · 4.8 KB

API Sistema Bancario

Tópicos

📌 Descrição do projeto

Este projeto é uma API que segue os padrões RESTful, a API foi desenvolvida para fazer as principais funções de um banco, como por exemplo a criação de contas, depositos e emissão de extrato de todas as transações efetuadas em uma determinada conta.

Ferramentas Utilizadas

Ferramentas Usadas

Como executar o projeto

Para executar o projeto é necessário ter o Node.js instalado.

Com o Node.js instalado basta fazer um clone do projeto

git clone https://github.com/Guilhsouza/banking-system-API.git

Abra o diretório do projeto

cd banking-system-API

Instale as dependências utilizando o comando:

npm i

Inicialize o servidor local:

npm run dev

Para testar todas as rotas, é possível utilizar o Postman ou o Insomnia.

Funcionalidades

Funções de contas

  • Criar uma conta:

    O programa cria uma conta na memória do banco após validar se os dados estão dentro dos padrões e confirmar se o CPF e E-mail não existem em outra conta.

  • Listar todas as contas do banco:

    O programa busca TODAS as contas existentes no banco e imprime na tela um array de objetos com as informações de cada uma.

  • Editar uma determinada conta:

    O programa busca a conta pelo número que é passado no parametro da URL, depois verifica se a conta existe, se existir faz a alteração de todos os dados.

  • Excluir uma determinada conta:

    O programa confirma se a conta existe, se existir ela exclui todo o objeto.


Funções de transações

  • Depósito:

    O programa verifica se a conta existe, e se os parametros foram passados corretamente, se sim, faz o depósito em uma conta específica. Os valores são passados em centavos e depois transformados em reais.

  • Saque:

    O programa verifica se a conta existe, se o saldo é suficiente e se a senha passada é a correta, se passar em todos os testes faz o saque da conta. Também é passado em centavos e depois convertido em reais.

  • Transferência:

    O programa verifica se ambas contas existem, se o saldo é suficiente da conta de origem e se a senha da conta de origem está correta. Também é passado em centavos e depois convertido em reais.


Funções de consulta

  • Consultar saldo:

    O programa vai procurar pelos parametros passados na URL se a conta existe comparando com o número da conta, se existir e a senha for correta, ele imprime o saldo atual da conta.

  • Consultar extrato:

    O programa vai procurar pelos parametros passados na URL se a conta existe comparando com o número da conta, se existir e a senha for correta, ele imprime o extrato de todas as transações que ocorreram na conta.

Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contanto o que você fez: git commit -m "feature: My new feature"
  4. Envie as alterações: git push origin my-feature

Autores

Guilherme Souza