README.md

🏦 API Banco

Esta API permite a gestão de contas bancárias, incluindo a criação de contas, transações, atualização de dados, exclusão de contas, consulta de saldo e emissão de extratos.

🔍 Índice

• Funcionalidades
• Tecnologias
• Programas necessários
• Documentação da API
  • Lista todas as contas bancárias existentes
  • Cria uma conta bancária
  • Atualizar usuário da conta bancária
  • Excluir uma conta bancária
  • Depositar em uma conta bancária
  • Sacar de uma conta bancária
  • Transferir valores entre contas bancárias
  • Consultar saldo da conta bancária
  • Emitir extrato bancário
• Rodando localmente

💡 Funcionalidades

• Criar conta bancária
• Listar contas bancárias
• Atualizar os dados do usuário da conta bancária
• Excluir uma conta bancária
• Depósitar em uma conta bancária
• Sacar de uma conta bancária
• Transferir valores entre contas bancárias
• Consultar saldo da conta bancária
• Emitir extrato bancário

🖥️ Tecnologias

• Javascript
• Node
• Express

⚙️ Programas necessários

• NodeJs

📃 Documentação da API

Lista todas as contas bancárias existentes

  GET /contas?senha_banco=Cubos123Bank

Parâmetro	Tipo	Descrição
senha	string	Senha do Banco

Request	Response

Cria uma conta bancária

  POST /contas

JSON	Tipo	Descrição
nome	string	Obrigatório
cpf	number	Obrigatório cpf válido
data_nascimento	number	Obrigatório
telefone	number	Obrigatório
email	string	Obrigatório email válido
senha	string	Obrigatório

Request	Response

Atualizar usuário da conta bancária

  PUT /contas/:numeroConta/usuario

Parâmetro	Tipo	Descrição
:numeroConta	number	Obrigatório id da conta

JSON	Tipo	Descrição
nome	string	Opcional
cpf	number	Opcional
data_nascimento	number	Opcional
telefone	number	Opcional
email	string	Opcional
senha	string	Opcional

Request	Response

Excluir uma conta bancária

  DELETE /contas/:numeroConta

Parâmetro	Tipo	Descrição
:numeroConta	number	Obrigatório id da conta

Request	Response

Depositar em uma conta bancária

  POST /transacoes/depositar

JSON	Tipo	Descrição
numero_conta	number	Obrigatório id da conta
valor	number	Obrigatório valor a ser depositado

Request	Response

Sacar de uma conta bancária

  POST /transacoes/sacar

JSON	Tipo	Descrição
numero_conta	number	Obrigatório id da conta
valor	number	Obrigatório valor a ser sacado
senha	string	Obrigatório senha da conta

Request	Response

Transferir valores entre contas bancárias

  POST /transacoes/transferir

JSON	Tipo	Descrição
numero_conta_origem	number	Obrigatório id da conta de origem
numero_conta_destino	number	Obrigatório id da conta de destino
valor	number	Obrigatório valor a ser sacado
senha	string	Obrigatório senha da conta de origem

Request	Response

Consultar saldo da conta bancária

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

Parâmetro	Tipo	Descrição
numeroConta	number	Obrigatório id da conta
senha	string	Obrigatório senha da conta

Request	Response

Emitir extrato bancário

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

Parâmetro	Tipo	Descrição
numeroConta	number	Obrigatório id da conta
senha	string	Obrigatório senha da conta

Request	Response

🛠️ Rodando localmente

Clone o projeto

  git clone https://github.com/LarissaAngioni/API-banco

Entre no diretório do projeto

  cd API-banco

Instale as dependências

  npm install

Inicie o servidor

  npm run start