elizcarvalho / challenge-bravo Goto Github PK

Português | English

Currency Converter API é resultado do desafio "Challenge-Bravo", seu objetivo é realizar conversão, com cotação atual, entre diferentes moedas utilizando dólar americano (USD) como moeda lastro, tais como: moedas mundiais (BRL, EUR, LBS, etc), criptomoedas (BTC, ETH) e moedas fictícias que podem ser cadastradas utilizando a API.

Como parceiro de integração (API parceira) para coleta das cotações das principais moedas/criptomoedas foi escolhida a API disponibilizada pela Coinbase. A escolha foi decorrente das seguintes motivações:

• Entregar, no mínimo, as cotações necessárias para cobrir o requisito funcional "Necessário realizar conversão entre as moedas BRL, USD, EUR, BTC, ETH.";
• Permitir, na chamada do seu endpoint, que seja informada a moeda lastro para que as cotações sejam em função desta;
• Possuir um rate limit de 10 mil requisições por hora.

A aplicação conta com políticas de retentativa e circuit breaker para oferecer resiliência, com o uso da biblioteca Polly.

Para o requisito funcional "Construa também um endpoint para adicionar e remover moedas suportadas pela API, usando os verbos HTTP.", foi escolhido o uso de banco não relacional MongoDB devido a estrutura flexível do dado e rápido processamento. Foram acrescentados dois índices para melhorar o desempenho nas consultas à base.

Como decisão tecnológica foi escolhido o uso do cache utilizando Redis, a fim de diminuir o tempo de acesso aos dados e por consequência o número de requisições à API parceira, uma vez que a listagem de acrônimos e de cotações ficarão armazenadas em cache durante o período de uma hora.

Foi decidido não armazenar em cache as cotações das moedas cadastradas na base, a fim de manter a conformidade dos valores mesmas na base e reduzir o tráfego de rede necessário para garantir a integridade (em ações de inserção, atualização e deleção) e tendo em vista que a velocidade de acesso a estes está assegurada com a combinação MongoDB e índices de busca.

Arquitetura foi desenvolvida em camadas e foram utilizados alguns padrões de projeto como:

• Repository: isolar a camada de dados, das camadas de negócio e aplicação;
• Circuit Breaker: tolerância a falha de indisponibilidade;
• Value Object: enviar dados para camada de apresentação sem expor às entidades utilizadas na persistência em base de dados;

Para execução dos testes unitários, construção e publicação da API em container foi utilizado um Dockerfile com multiplos estágios, resultando ao fim em uma imagem com tamanho em disco em torno de 250MB.

• A etapa de criação de um projeto em .NET (API e Tests), cria por padrão algumas estruturas mínima de diretórios e arquivos (properties/launchSettings.json, appsettings.json, Program).
• Não foi incluído no momento da criação da solução/projeto suporte à docker e openAPI, sendo estes configurados manualmente posteriormente.

Faz-se necessário ter o Docker instalado e funcionando corretamente.

1. Clone o repositório

   git clone https://github.com/ElizCarvalho/challenge-bravo.git

2. Acesse o diretório da aplicação, por exemplo:

   cd .\challenge-bravo\CurrencyConverterAPI

3. Suba os containers

   docker-compose up -d --build

4. Acesse a documentação da API através da url http://localhost:9000

5. Acesse a coleção do Postman como apoio e teste de integração, disponível em: challenge-bravo\CurrencyConverterAPI\PostmanCollection

Para este projeto foram orquestrados junto à API, os containers:

• Mongo: base de dados não relacional MongoDB;
• Redis: cache;
• SEQ: visualização dos logs gerados pela aplicação através da biblioteca 'Serilog';
  • http://localhost:5341, clique aqui para acessar
  • Utilize os dados de acesso: Username: admin e Password: bravo@123.
• Prometheus: visualização das métricas disponibilizadas pela aplicação através da biblioteca 'Prometheus';
  • http://localhost:9090, clique aqui para acessar
  • No campo Expression utilize o filtro http_requests_received_total e clique no botão Execute. É possível, com isso, verificar a quantidade de requisições realizadas até o momento para cada endpoint da API.

• Adicionar endpoint para atualizar somente o valor da moeda registrada na base (PATCH);
• Utilizar secrets para passwords/hashs;
• Testes de integração com base de dados;
• HATEOS