juanfariasdev / API-Rest-NodeJS

API Rest using Typescript and NodeJS

Click here to read the README in English

Projeto: API-Rest-NodeJS

Trilha: NodeJS 2023

API desenvolvida durante as aulas da Rocketseat

Tecnologias Utilizadas

• Typescript
• NodeJS

Bibliotecas

• Fastify
• Knex
• Zod
• Dotenv

Testes

• Vitest
• Supertest

Banco de Dados

• SQlite3
• Postgres

Resumo

O projeto "API-Rest-NodeJS" tem como objetivo desenvolver uma API REST utilizando Fastify, Typescript e outras ferramentas mencionadas.

Requisitos Funcionais

• Permitir ao usuário criar uma nova transação.
• Permitir ao usuário deletar uma transação.
• Permitir ao usuário obter um resumo da sua conta.
• Permitir ao usuário listar todas as transações ocorridas.
• Permitir ao usuário visualizar uma transação específica.

Requisitos Não Funcionais

• As transações devem ser classificadas como crédito (adicionar ao valor total) ou débito (subtrair do valor total).
• Identificação do usuário deve ser mantida entre as requisições.
• O usuário só pode visualizar as transações que ele criou.

Instalação e Execução

Siga as instruções abaixo para instalar e executar o projeto:

1. Execute o comando npm install para instalar as dependências.
2. Execute o comando npm run build para realizar a compilação do projeto.
3. Execute o comando npm run knex -- migrate:latest para executar as migrações do banco de dados.

Para iniciar o projeto em modo de desenvolvimento, após instalar as dependências execute o comando npm run dev.

Rotas

• GET /session:

  • Cria uma sessão e salva no cookie.

• GET /transactions:

  • Lista todas as transações de acordo com o usuário.

• GET /transactions/ID:

  • Lista uma transação específica de acordo com o ID.

• GET /transactions/summary:

  • Mostra um resumo dos valores da conta, incluindo o TOTAL, CRÉDITO e DÉBITO.

• DELETE /transactions/ID:

  • Deleta uma transação específica de acordo com o ID.

• POST /transactions:

  • Adiciona uma nova transação.
  • Aceita o seguinte formato de dados:

  {
    "title": "Isso é um título", // Coloque o título aqui
    "amount": 1200, // Valor
    "type": "credit" // Tipo da transação: "credit" ou "debit"
  }