Desafio Back-end Módulo 2 - Curso de Desnvolvimento de Software Cubos Academy

Construção de uma RESTful API que permita:

  • 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

Persistências dos dados

Os dados serão persistidos em memória, no objeto existente dentro do arquivo bancodedados.js.

Estrutura do objeto no arquivo bancodedados.js

{
    banco: {
        nome: "Cubos Bank",
        numero: "123",
        agencia: "0001",
        senha: "Cubos123Bank",
    },
    contas: [
        // array de contas bancárias
    ],
    saques: [
        // array de saques
    ],
    depositos: [
        // array de depósitos
    ],
    transferencias: [
        // array de transferências
    ],
}

Endpoints

Listar contas bancárias

GET /contas?senha_banco=Cubos123Bank

Esse endpoint lista todas as contas bancárias existentes.

  • Requisição - query params (respeitando este nome)

    • senha_banco
  • Resposta

    • listagem de todas as contas bancárias existentes

Exemplo de resposta

// HTTP Status 200
// 2 contas encontradas
[
    {
        "numero": "1",
        "saldo": 0,
        "usuario": {
            "nome": "Foo Bar",
            "cpf": "00011122233",
            "data_nascimento": "2021-03-15",
            "telefone": "71999998888",
            "email": "foo@bar.com",
            "senha": "1234"
        }
    },
    {
        "numero": "2",
        "saldo": 1000,
        "usuario": {
            "nome": "Foo Bar 2",
            "cpf": "00011122234",
            "data_nascimento": "2021-03-15",
            "telefone": "71999998888",
            "email": "foo@bar2.com",
            "senha": "12345"
        }
    }
]

// nenhuma conta encontrada
[]
// HTTP Status 401
{
    "mensagem": "A senha do banco informada é inválida!"
}

Criar conta bancária

POST /contas

Esse endpoint cria uma conta bancária, onde é 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 (respeitando estes nomes):

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

Exemplo de Requisição

// POST /contas
{
    "nome": "Foo Bar 2",
    "cpf": "00011122234",
    "data_nascimento": "2021-03-15",
    "telefone": "71999998888",
    "email": "foo@bar2.com",
    "senha": "12345"
}

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400
{
    "mensagem": "O cpf informado já pertence a outra conta!"
}

Atualizar usuário da conta bancária

PUT /contas/:numeroConta/usuario

Esse endpoint atualiza 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

Exemplo de Requisição

// PUT /contas/:numeroConta/usuario
{
    "nome": "Foo Bar 3",
    "cpf": "99911122234",
    "data_nascimento": "2021-03-15",
    "telefone": "71999998888",
    "email": "foo@bar3.com",
    "senha": "12345"
{

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400
{
    "mensagem": "O cpf informado já pertence a outra conta!"
}

Excluir Conta

DELETE /contas/:numeroConta

Esse endpoint exclui uma conta bancária existente.

  • Requisição

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

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400
{
    "mensagem": "Não é possível deletar uma conta com saldo diferente de 0!"
}

Depositar

POST /transacoes/depositar

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

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

    • numero_conta
    • valor

Exemplo de Requisição

// POST /transacoes/depositar
{
	"numero_conta": "1",
	"valor": 1900
}

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400 / 401 / 403 / 404
{
    "mensagem": "O valor de depósito deve ser maior que 0!"
}

Exemplo do registro de um depósito

{
    "data": "2021-08-10 23:40:35",
    "numero_conta": "1",
    "valor": 10000
}

Sacar

POST /transacoes/sacar

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

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

    • numero_conta
    • valor
    • senha

Exemplo de Requisição

// POST /transacoes/sacar
{
  "numero_conta": "1",
  "valor": 1900,
  "senha": "123456"
}

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400
{
    "mensagem": "Saldo menor que o valor do saque!"
}

Exemplo do registro de um saque

{
    "data": "2021-08-10 23:40:35",
    "numero_conta": "1",
    "valor": 10000
}

Tranferir

POST /transacoes/transferir

Esse endpoint permite a transferência de recursos (dinheiro) de uma conta bancária para outra e registra 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

Exemplo de Requisição

// POST /transacoes/transferir
{
	"numero_conta_origem": "1",
	"numero_conta_destino": "2",
	"valor": 200,
	"senha": "123456"
}

Exemplo de Resposta

// HTTP Status 204
// Sem conteúdo no corpo (body) da resposta
// HTTP Status 400
{
    "mensagem": "Saldo menor que o valor da transferência!"
}

Exemplo do registro de uma transferência

{
    "data": "2021-08-10 23:40:35",
    "numero_conta_origem": "1",
    "numero_conta_destino": "2",
    "valor": 10000
}

Saldo

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

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

  • Requisição - query params

    • numero_conta
    • senha

Exemplo de Resposta

// HTTP Status 200
{
    "saldo": 13000
}
// HTTP Status 404
{
    "mensagem": "Numero da conta não encontrado!"
}

Extrato

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

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

  • Requisição - query params

    • numero_conta
    • senha

Exemplo de Resposta

// HTTP Status 200
{
  "seusDepositos": [
    {
      "data": "2021-08-18 20:46:03",
      "numero_conta": "1",
      "valor": 10000
    },
    {
      "data": "2021-08-18 20:46:06",
      "numero_conta": "1",
      "valor": 10000
    }
  ],
  "seusSaques": [
    {
      "data": "2021-08-18 20:46:18",
      "numero_conta": "1",
      "valor": 1000
    }
  ],
  "transferenciasEnviadas": [
    {
      "data": "2021-08-18 20:47:10",
      "numero_conta_origem": "1",
      "numero_conta_destino": "2",
      "valor": 5000
    }
  ],
  "transferenciasRecebidas": [
    {
      "data": "2021-08-18 20:47:24",
      "numero_conta_origem": "2",
      "numero_conta_destino": "1",
      "valor": 2000
    },
    {
      "data": "2021-08-18 20:47:26",
      "numero_conta_origem": "2",
      "numero_conta_destino": "1",
      "valor": 2000
    }
  ]
}
// HTTP Status 404
{
    "mensagem": "Numero da conta não encontrado!"
}
tags: back-end nodeJS API REST