giovaneDamaso/API_Banco

API de banco construída em decorrer do curso de desenvolvimento Back-End oferecido pela Cubos Academy.

💰 API: Banco 💰

API de banco construída em decorrer do curso de desenvolvimento Back-End oferecido pela Cubos Academy.

🖥️ Linguagem:

🌐 Ambiente de execução:

📚 Bibliotecas:

🔧 Ferramenta de teste:

🚀 Como utilizar:

Primeiro deve-se fazer o fork do projeto, e em seguida clonar o reposítório do fork para sua máquina. Após o clone, as dependências devem ser instaladas através do npm. Para que o servidor seja iniciado na máquina, é necessário acessar a pasta do projeto /API_Banco e no terminal, rodar o comando npm run dev no terminal.

💼 Funções e Endpoints da API:

• 🔭 Listar contas bancárias de usuários - GET localhost:3000/contas?senha_banco=Cubos123Bank

  Para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo GET no Insmonia e utilizar a senha informada no arquivo bancodedados.js como parâmetro na rota.

  

• ✔️ Criar conta de usuário - POST localhost:3000/contas

  Para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo POST no Insmonia. Logo abaixo, na aba Body, selecionar o formato JSON e inserir um objeto no formato JSON preenchendo os campos:

  {
        "nome": "",
        "cpf": "",
        "data_nascimento": "",
        "telefone": "", "email": "",
        "senha": ""
  }

  
  

• ♻️ Atualizar informações da conta de um usuário - PUT localhost:3000/contas/:numeroConta/usuario

  Para atualizar a conta, deve-se criar um HTTP Request com o verbo PUT no Insmonia. Após isso, o procedimento é similar ao acima, de criação de conta. Entretanto, lembre-se que duas contas não podem possuir o mesmo CPF.

• ❌ Remover conta bancária de um usuário - DELETE localhost:3000/contas/:numeroConta

  Para remover uma conta, deve-se criar um HTTP Request com o verbo DELETE, passando como parâmatro o número da conta a ser excluída.

  

• 💵 Depositar valor - POST localhost:3000/transacoes/depositar

  Esta funcionalidade utilizará a biblioteca date-fns, por isso, esta deve ser instalada utilizando o comando npm install date-fns.

  Para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo POST no Insmonia. Logo abaixo, na aba Body, selecionar o formato JSON e inserir um objeto no formato JSON preenchendo os campos numero da conta e valor a ser depositado:

  {
        "numero_conta": "",
        "valor": 0
  }

  

• 💸 Sacar valor - POST localhost:3000"/transacoes/sacar

  Semelhante depósito, para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo POST no Insmonia. Logo abaixo, na aba Body, selecionar o formato JSON e inserir um objeto no formato JSON preenchendo os campos numero da conta, valor a ser sacado e agora uma senha é necessária:

  {
        "numero_conta": "",
        "valor": 0,
        "senha": ""
  }

  

• 📤 Transferir valor entre contas - POST localhost:3000/transacoes/transferir

  Para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo POST no Insmonia. Logo abaixo, na aba Body, selecionar o formato JSON e inserir um objeto no formato JSON preenchendo os campos numero da conta de origem, numero da conta destino, valor a ser sacado e senha da conta de origem:

  {
        "numero_conta_origem": "",
        "numero_conta_destino": "",
        "valor": 0,
        "senha": ""
  }

  

• 💹 Exibir saldo da conta - GET localhost:3000/contas/saldo

  Para acessar esta funcionalidade, deve-se criar um HTTP Request com o verbo GET no Insmonia e utilizar o numero da conta a ser acessada e sua respectiva senha como parâmetros na rota:

  

• 🧾 Retirar extrato da conta - GET localhost:3000/contas/extrato

  Assim como na funcionalidade de exibir saldo, deve-se criar um HTTP Request com o verbo GET no Insmonia e utilizar o numero da conta a ser acessada e sua respectiva senha como parâmetros na rota: