Challenge API Financeira

API desenvolvida com base no Challenge Alura

Etiquetas

Instalação

Instale a API com NPM

  npm install

Execução

  npm start

Execução dos testes de integração

  npm run tests

Execução dos testes unitários do service

  npm run testUnitary

Documentação da API

Receitas

Retorna as receitas salvas

  GET /api/receitas

Retorna uma receita

  GET /api/receitas/${id}

Parâmetro	Tipo	Descrição
id	int	Obrigatório. O ID do item que você quer

Adicionar uma receita

A API não deve permitir o cadastro de receitas duplicadas(contendo a mesma descrição, dentro do mesmo mês)

  POST /api/receitas

Parâmetro	Tipo	Descrição
descricao	string	Obrigatório. A descrição da receita que será salva
valor	float	Obrigatório. Valor da receita
mes	string	Obrigatório. Mês de referência

Adicionar várias receitas

A API não deve permitir o cadastro de receitas duplicadas(contendo a mesma descrição, dentro do mesmo mês)

  POST /api/receitas/many

Parâmetro	Tipo	Descrição
descricao	string	Obrigatório. A descrição da receita que será salva
valor	float	Obrigatório. Valor da receita
mes	string	Obrigatório. Mês de referência

Deleta uma receita

  GET /api/receitas/${id}

Parâmetro	Tipo	Descrição
id	int	Obrigatório. O ID do item que você quer

Deleta todas as receita (truncate)

  GET /api/receitas

Despesas

Retorna as despesas salvas

  GET /api/receitas

Retorna uma despesa

  GET /api/receitas/${id}

Parâmetro	Tipo	Descrição
id	int	Obrigatório. O ID do item que você quer

Adicionar uma despesa

A API não deve permitir o cadastro de depesas duplicadas(contendo a mesma descrição, dentro do mesmo mês)

  POST /api/receitas

Parâmetro	Tipo	Descrição
descricao	string	Obrigatório. A descrição da receita que será salva
valor	float	Obrigatório. Valor da receita
mes	string	Obrigatório. Mês de referência

Adicionar várias despesas

A API não deve permitir o cadastro de depesas duplicadas(contendo a mesma descrição, dentro do mesmo mês)

  POST /api/receitas/many

Parâmetro	Tipo	Descrição
descricao	string	Obrigatório. A descrição da receita que será salva
valor	float	Obrigatório. Valor da receita
mes	string	Obrigatório. Mês de referência

Deleta uma despesa

  GET /api/receitas/${id}

Parâmetro	Tipo	Descrição
id	int	Obrigatório. O ID do item que você quer

Deleta todas as despesas (truncate)

  GET /api/receitas