phdevss / finapi

Development with Rocketseat

finAPI

Este projeto foi desenvolvido junto com a Rocketseat. Ele é uma simples API de um banco com as funcionalidades descritas abaixo.

Itens de projeto

Requisitos

• Deve ser possível criar uma conta
• Deve ser possível buscar o extrato bancário do cliente
• Deve ser possível realizar um saque
• Deve ser possível realizar um depósito
• Deve ser possível buscar o extrato bancário do cliente por data
• Deve ser possível atualizar os dados da conta do cliente
• Deve ser possível obter dados da conta do cliente
• Deve ser possível deletar uma conta

---

Regras de negócio

• Não deve ser possível cadastrar uma conta com o CPF já existente
• Não deve ser possível fazer depósito em uma conta não existente
• Não deve ser possível buscar extrato em uma conta não existente
• Não deve ser possível fazer saque em uma conta não existente
• Não deve ser possível excluir uma conta não existente
• Não deve ser possível fazer saque quando o saldo for insuficiente
• Deve ser possível retornar o balanço da account

Tecnologias utilizadas

• Typescript
• Express
• Prettier

✔️ Documentação da API

Cadastra usuário

  POST /account

Body Parâmetros	Tipo	Descrição
name	string	Obrigatório
cpf	string	Obrigatório

Retorna o status code 201

Realiza um depósito

  POST /deposit

Body Parâmetros	Tipo	Descrição
description	string	Opcional
amount	number	Obrigatório

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna o status code 201

Realiza um saque

  POST /withdraw

Body Parâmetros	Tipo	Descrição
description	string	Opcional
amount	number	Obrigatório

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna o status code 201

Solicita extrato completo do cliente

  GET /statement

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna extrato completo do cliente

Solicita extrato na data informada

  GET /statement/date

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Query Parâmetros	Tipo	Descrição
date	string	Obrigatório -> Exemplo formato: "2022-10-28"

Retorna extrato na data informada

Solicita informações da conta

  GET /statement/date

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna informações da conta

Solicita balanço da conta

  GET /statement/date

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna balanço da conta

Solicita exclusão da conta

  DEL /account

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Retorna status 204

Solicita alteração dos dados da conta

  PUT /account

Header Parâmetros	Tipo	Descrição
cpf	string	Obrigatório

Body Parâmetros	Tipo	Descrição
name	string	Obrigatório

Retorna status 201

📁 Instalando e rodando localmente

Clone o projeto

  git clone https://github.com/PHDevss/finAPI.git

Entre no diretório do projeto

  cd finAPI

Instale as dependências

  npm install

Inicie o servidor

  npm run start

Status

🚧 🚧