API de Moedas #290

CharlesSchiavinato · 2023-02-24T20:15:05Z

Descrição da API

API para conversão de moedas onde é possível realiza a conversão entre as moedas previamentes cadastradas.

Existe um cronjob para manter as taxas de conversões atualizadas das principais moedas como Dolar (USD), Euro (EUR), Real (BRL), etc desde que a moeda esteja cadastrada no sistema.

No cadastro da Moeda contém a data de referencia da taxa de cambio utilizada para conversão isso ajuda o usuário a saber se a taxa está atualizada, principalmente para os casos de moedas que não são atualizadas automaticamente.

A Modeda utilizada como lastro é o Dolar (USD).

É possível realizar todas as operações de CRUD de Moedas e realizar a Conversão.

A documentação dos endpoints estão disponíveis na própria API "/docs".

Etapas para poder executar a API na máquina local

Docker instalado. documentação
Docker-compose instalado. documentação
Go instalado. documentação

Obs: Os comandos a seguir devem ser executados na pasta raiz do projeto.

Subir os serviços de banco de dados e de cache utilizados pela API
```
make docker-compose-up
```
ou
```
docker-compose up -d
```

Executar a API

Direto na máquina local
```
make go-run
```
ou
```
go run server.go
```
Dentro do Docker
```
make docker-build
make docker-run
```

Endpoint da API localhost:9000
Endpoin da documentação da API localhost:9000/docs

Informações sobre a atualização automatica das taxas de cambio

Encontrei um endpoint publico para obter as taxas de cambio do Banco Central Europeu. link

Esse endpoint tem como lastro a moeda Euro (EUR) onde fiz um de/para no código para tornar o Dolar (USD) a moeda de lastro.

Optei por usar esse endpoint pela veracidade da informação por ser do Banco Central da Europa e também porque não encontrei facilmente um endpoint publico para obter a taxa de cambio em dolar, então preferi utilizar o tempo para implementar mais recursos na API que na minha visão acredito fazer mais sentido para vcs avaliarem a minha maturidade em desenvolvimento.

Descrição Técnica

Banco de dados Postgres por ser um serviço de banco relacional robusto, completo e open source que atende perfeitamente desde pequenas aplicações até apliações robustas e compatível com serviços de banco
Cache Redis por ser um serviço de cache robusto, open source, amplamente utilizado e compatível com serviço de cache em nuvem como o memory store do GCP. O cace é utilizado para melhoria de performance no endpoint de conversão e para controle da atualiação automatica das taxas de cambio
Migration para versionamento de alterações no banco de dados.
Health Check localhost:9000/healthz para monitorar se a aplicação está no ar e se os serviços de banco de dados e cache estão funcionando.
Swagger para manter a documentação da API atualizada de forma automática utilizando tags no código.
CORS para poder permitir requisições de origem diferente da API.
Middleware para logar o resultado de todas as requisição contendo informações da origem da requisição e request id para ajudar no troubleshooting da aplicação. O request id ajuda a rastrear um a mesma requisição por diversos microservicos e as informações da origem ajudam a identificar se o problema está relacionado a uma origem ou dispositivo especifico.
CronJob que executa a cada 30 minutos para buscar as taxas de cambio do dia e atualizar nossa API. O endpoint utilizado é atualizado apenas uma vez por dia mas coloquei para rodar de 30 em 30 minutos caso aconteça algum erro no processo de atualização. Antes de fazer a requisição para obter as informações a API verifica se o mesmo já foi atualizado no dia e caso positivo ignora a execução.
Carregamento de configurações da API através de váriaveis de ambiente ou arquivo de configuração "config.env" na pasta raiz da aplicação.
Testes Unitários. Aplicados apenas na inclusão de Moeda para demonstrar conhecimento. Tenho total conciencia que é importante e que deve ser aplicada em toda a API. Inclusive tenho conhecimento de TDD para iniciar o desenvovimento a partir dos testes.
Projeto já contém um arquivo config.env com todas as configurações necessárias para poder executar a API no ambiente local.
Docker-compose para poder subir os serviços de banco de dados e cache para poder rodas a API no ambiente local.
Dockfile para poder realizar o build da API e gerar imagem docker para rodar no ambiente local.
Github Action para validar PR e Push para a branch main iniciando um processo de CI/CD.
Makefile para poder executar de forma simples diversos comandos.
É possível trocar o manipulador de rotas, banco de dados e serviço de cache facilmente devido a utilização do Clean Architecture no projeto.

Geração da Documentação da API - Swagger

Instalar na máquina o go-swagger
Especificação das tags para geração automatica da documentação aqui
Executar o comando abaixo na pasta raiz da API para atualizar a documentação
```
make swagger
```

Sugestões de Melhorias

Restringir acesso aos endpoints de CRUD de Moedas para evitar alteração indevida
Incluir na documentação da API a relação dos erros que podem ser retornado
Refatorar as validações de erros.
Criar paginação no endpoint que lista todas as Moedas
Substituir ID sequencial por UUID
Incluir cabeçalhos HTTP de segurança
Incluir controle de auditoria
Atualização assincrona das moedas através do cronjob

Obs: Com certeza tem mais melhorias a ser feita tanto no código quanto na documentação. Melhoria continua deve fazer parte da vida útil de toda aplicação.

Espero que gostem bastante do projeto que entreguei ;)

Create HTTP handler custom to logger all request response

Include gracefully shutdown the server Include Handler Logger Include Currency Model Include Currency Route Include Currency Controller Include Swagger Doc Inclue Makefile

Include HandleFunc NotFound Update Swagger Documentation Update Middleware Logger

Include Currency Usecase Test Update Currency Controller Include Currency Controller Test Include Currency Usercase Mock Update Curency Model Refactor Middleware Logger Include Service Logger

Include Config Load Env Include docker-compose Include Repository Interface Include Repository Postgres Include Currency Repository Interface Include Currency Repository Postgres Include Migration Database Update Swagger Documentation Update Currency Controller Update Currency Controller Test Update Currency Usecase Mock Update Currency Usecase

Include Cache Interface Include Currency Cache Interface Include Cache Redis Include Currency Cache Redis Update Currency Usecase Update Currency Usecase Mock

Update README Update Swagger Documentation Include Healthz Controller Include Exchange Rate CronJob Update Cache Mock Update Repository Mock Update Currency Model Include Exchange Rate Model Include Healthz Model Include Healthz Route Update Currency Cache Update Currency Redis Cache Update Migration Update Currency Repository Update Currency Postgres Repository Update Currency Usecase Include Exchange Rate Usecasa Update Config

Include Github Actions Include Exchange Rate Cache Include Exchange Rate Redis Cache Update Config Update Dockerfile

Update Github Action Update Currency Controller Test

CharlesSchiavinato added 11 commits February 16, 2023 19:35

Create Server using clean architecture

ec4199b

Create HTTP handler custom to logger all request response

Config Server Http

6e05419

Include gracefully shutdown the server Include Handler Logger Include Currency Model Include Currency Route Include Currency Controller Include Swagger Doc Inclue Makefile

Include middleware CORS

dea49b5

Include HandleFunc NotFound Update Swagger Documentation Update Middleware Logger

Include Currency Usecase

81abc61

Include Currency Usecase Test Update Currency Controller Include Currency Controller Test Include Currency Usercase Mock Update Curency Model Refactor Middleware Logger Include Service Logger

Include Cache Service

3159a7c

Include Cache Interface Include Currency Cache Interface Include Cache Redis Include Currency Cache Redis Update Currency Usecase Update Currency Usecase Mock

Update README

a0be85a

Include Github Actions Include Exchange Rate Cache Include Exchange Rate Redis Cache Update Config Update Dockerfile

Update Github Action

88e5cba

Update README

7042bdd

Update README

544a3f4

Update Github Action Update Currency Controller Test

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API de Moedas #290

API de Moedas #290

CharlesSchiavinato commented Feb 24, 2023 •

edited

API de Moedas #290

Are you sure you want to change the base?

API de Moedas #290

Conversation

CharlesSchiavinato commented Feb 24, 2023 • edited

Descrição da API

Etapas para poder executar a API na máquina local

Obs: Os comandos a seguir devem ser executados na pasta raiz do projeto.

Informações sobre a atualização automatica das taxas de cambio

Descrição Técnica

Geração da Documentação da API - Swagger

Sugestões de Melhorias

Obs: Com certeza tem mais melhorias a ser feita tanto no código quanto na documentação. Melhoria continua deve fazer parte da vida útil de toda aplicação.

Espero que gostem bastante do projeto que entreguei ;)

CharlesSchiavinato commented Feb 24, 2023 •

edited