API REST - Banco Digital

🚧 Banco Digital 🚧

📄 Sobre o projeto

Esse projeto é fruto do Desafio do Módulo 2 (Turma B2BT05) do curso de Desenvolvimento de Software com foco em back-end, ofertado pela Cubos Academy.

- Objetivo

O presente projeto tem como objetivo o desenvolvimento de uma API para um Banco Digital. Sendo um projeto piloto, ele estará preparado para receber novas funcionalidades ao longo do tempo.

⚙️ Funcionalidades

• Contas:

  • Criar conta bancária
  • Listar contas bancárias
  • Atualizar os dados do usuário da conta bancária
  • Excluir uma conta bancária
  • Consultar saldo da conta bancária
  • Emitir extrato bancário

• Transações:

  • Depositar em uma conta bancária
  • Sacar de uma conta bancária
  • Transferir valores entre contas bancárias

📝 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

💻 Execução do projeto

Criar conta bancária

POST /contas

Esse endpoint criará uma conta bancária, onde será gerado um número único para identificação da conta (número da conta).

• Requisição - O corpo (body) deverá possuir um objeto com as seguintes propriedades:

  • nome
  • cpf
  • data_nascimento
  • telefone
  • email
  • senha

• Resposta

A atualização será visualizada ao se listar as contas.

Demonstração:

Listar contas bancárias

GET /contas?senha_banco=Cubos123Bank

Esse endpoint irá listar todas as contas bancárias existentes.

• Requisição - query params

  • senha_banco

• Resposta

listagem de todas as contas bancárias existentes

Demonstração:

Atualizar usuário da conta bancária

PUT /contas/:numeroConta/usuario

Esse endpoint irá atualizar apenas os dados do usuário de uma conta bancária.

• Requisição - O corpo (body) deverá possuir um objeto com todas as seguintes propriedades (respeitando estes nomes):

  • nome
  • cpf
  • data_nascimento
  • telefone
  • email
  • senha

O número da conta deverá ser informado na URL (query params).

• Resposta

A atualização será visualizada ao se listar as contas novamente.

Demonstração:

Excluir Conta

DELETE /contas/:numeroConta

Esse endpoint irá excluir uma conta bancária existente.

• Requisição

Numero da conta bancária (passado como parâmetro na rota)

• Resposta

A exclusão será visualizada ao se listar as contas novamente.

Demonstração:

Depositar

POST /transacoes/depositar

Esse endpoint irá somar o valor do depósito ao saldo de uma conta válida e registrar essa transação.

• Requisição - O corpo (body) deverá possuir um objeto com as seguintes propriedades:

  • numero_conta
  • valor

• Resposta

A atualização será visualizada ao se listar as contas novamente.

Demonstração:

Sacar

POST /transacoes/sacar

Esse endpoint irá realizar o saque de um valor em uma determinada conta bancária e registrar essa transação.

• Requisição - O corpo (body) deverá possuir um objeto com as seguintes propriedades (respeitando estes nomes):

  • numero_conta
  • valor
  • senha

• Resposta

A atualização será visualizada ao se listar as contas novamente.

Demonstração:

Tranferir

POST /transacoes/transferir

Esse endpoint permitirá a transferência de recursos de uma conta bancária para outra e registrar essa transação.

• Requisição - O corpo (body) deverá possuir um objeto com as seguintes propriedades (respeitando estes nomes):

  • numero_conta_origem
  • numero_conta_destino
  • valor
  • senha

• Resposta

A atualização será visualizada ao se listar as contas novamente.

Demonstração:

Saldo

GET /contas/saldo?numero_conta=123&senha=123

Esse endpoint retornará o saldo de uma conta bancária.

• Requisição - query params

  • numero_conta
  • senha

• Resposta

Saldo da conta

Demonstração:

Extrato

GET /contas/extrato?numero_conta=123&senha=123

Esse endpoint listará as transações realizadas de uma conta específica.

• Requisição - query params

  • numero_conta
  • senha

• Resposta

Relatório da conta

Demonstração:

🛠 Tecnologias

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

• Editor: Visual Studio Code
• Teste de API: Insomnia

🧙‍♂️ Autora

Hemile Paixão

Entre em contato!