mathlaza / poo-trix

Uma API orientada a objetos com Mongoose, para gerenciamento de transferências bancárias.

API OO Trix

Projeto disponibilizado pela Trybe e construído durante as aulas do módulo de back-end, para estudo de Mongoose e POO.

Uma API orientada a objetos para gerenciamento de transferências bancárias.

Essa API é usada como exemplo didático para o bloco de Arquitetura de Software do Curso de Desenvolvimento Web da Trybe.

Rodando a aplicação inicial via Docker

• Inicie os contêineres via Docker Compose:

  docker-compose up -d

👀 Observação: Dois contêineres irão subir! Um para a aplicação Node TypeScript, denominado trix e outro para o banco de dados MongoDB, denominado trix_db

• Para acessar o contêiner do banco de dados, basta executar comando abaixo:

    docker exec -it trix_db mongo

  👀 Observação: Aqui você pode executar comandos como: show dbs, use #COLLECTION_NAME, show collections e etc...

• Para acessar o contêiner da aplicação, basta executar comando abaixo:

  docker exec -it trix bash

---

Lista de endpoints

⚠️ Dica: Há uma coleção dos endpoints em formato JSON para importação na extensão Thunder Client do VS Code no arquivo thunder-trix.json

Como importar a coleção no Thunder Client

1. Abra a aba da extensão Thunder Client;
2. Clique na aba Collections;
3. Clique no menu de opções;
4. Clique em Import;
5. Escolha o arquivo thunder-trix.json;
6. Clique em OK.

1° Dia

• Feitos no course:
  • POST /transfer;
• Feitos na aula ao vivo:
  • PATCH /transfer/:id;
• Para serem feitos no exercício do dia:
  • GET /transfer;
  • GET /transfer/:key;

2° Dia

• Feitos no course:
  • POST /key/register;
• Feitos na aula ao vivo:
  • GET /key/:value;
• Para serem feitos no exercício do dia:
  • GET /key/owner/:name;