Matheus-Pazinati / transactions-api

API para criação/visualização de transações financeiras.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Transactions API 💱


🏦 Sobre

Serviço Web (API) para registrar transações financeiras de uma pessoa ou empresa.


🎯 Objetivo

Aplicar na prática os conhecimentos obtidos em algumas ferramentas que auxiliam a criação de uma API, como o Fastify para lidar com as requisições HTTP, o knex como Query Builder para manipular o banco de dados, Vitest para criar os testes das requisições, entre outras.


🛠️ Tecnologias e ferramentas/bibliotecas utilizadas


💻 Como executar o projeto localmente

  1. Faça fork ou baixe o projeto na sua máquina
  2. Abra o projeto em um editor de códigos, e execute o comando npm install no terminal, para baixar as dependências do projeto
  3. Rode o comando npm run dev, que irá subir o servidor localmente no seu computador, na porta 3333
  4. Pronto. O servidor já estará sendo executado no endereço http://localhost:3333.

🚊 Rotas e métodos

  • Criar uma nova transação: Rota: /transactions | Método: PUT | Body da Requisição: title, amount e type
  • Listar todas as transações de um usuário: Rota: /transactions | Método: GET
  • Listar uma transação específica: Rota: /transactions/:id | Método: GET
  • Deletar uma transação específica: Rota: /transactions/:id | Método: DELETE
  • Editar uma transação específica: Rota: /transactions/:id | Método: PUT | Body da Requisição: title, amount ou type
  • Buscar o resumo das transações (Diferença entre Entradas e Saídas): Rota: /transactions/summary | Método: GET

📌 Funcionalidades a serem implementadas

  • Criar uma rota para deletar uma transação (somente o usuário que criou a transação pode deleta-la) - Ok ✔️
  • Criar uma rota para alterar uma transação (somente o usuário que criou a transação pode altera-la) - Ok ✔️


Made by Matheus Pazinati 🛸

About

API para criação/visualização de transações financeiras.


Languages

Language:TypeScript 100.0%