Esta é uma API criada somente com NodeJS nativo para fins de estudo.
Nesta api utilizei a memória para persistir os dados, simulando um banco de dados. Também criei um mini framework para criar as rotas e elucidar um conhecimento mais profundo sobre muitos conceitos do NodeJS nativo (sem bibliotecas)
Primeiro certifique-se de ter as seguintes ferramentas instaladas:
npm install --global yarn && \
yarn --version
Primeiro clone o projeto:
git clone --branch entrypoint https://github.com/jeanmolossi/cautious-octo-goggles.git introducao-nodejs
Acesse a pasta:
cd introducao-nodejs
Se você clonou a branch entrypoint
provavelmente seu projeto estará vazio. Entretanto, se você clonou a partir da branch nodejs-nativo poderá executar:
yarn dev
Após seu projeto rodar com sucesso, acesse a pasta: http
, você encontrará um arquivo de requests. Para conseguir executál-as você precisa da extensão REST Client.
Para instalar a extensão:
Em seu VSCode aperte simultaneamente as teclas (Ctrl + P) e cole o seguinte comando: ext install humao.rest-client
Com a extensão instalada basta clicar em send request
que aparece em cima do host de cada chamada.
- 1 - Certifique-se que a aplicação está executando
- 2 - Clique em send request
- 3 - Receba o retorno da API
- Criar entrada de caixa
- Criar saída de caixa
- Histórico de entradas e saídas
Modelo de entrada
{
"id": "random-uuid",
"note": "Pizza iFood",
"type": "outcome",
"value": 6990,
"created_at": "2022-06-04T15:01:23.000Z"
}
Modelo de saída
{
"id": "random-uuid",
"note": "Salário",
"type": "income",
"value": 160087,
"created_at": "2022-06-04T15:01:23.000Z"
}
Rotas da api
Caminho | Método | Ação |
---|---|---|
/ping | GET | Rota para checar saúde da aplicação |
/transaction | POST | Cadastro de nova transação |
/transaction/{{id}} | DELETE | Excluir transação |
/transactions | GET | Recupera o histórico de transações |