Este projeto desenvolve uma API REST utilizando o Django, o código segue padrão do Django com a Documentação do Django Rest Framework.
Bibliotecas Auxiliares:
- Django
- Django Rest Framework
- Celery
- Django Decouple
- Django Celery Results
- Gunicorn
- Requests
- Django Storages
OBS1: Os commits contém um histórico do código.
OBS2: Vou tentar desenvolver o sistema de Fila e Cache.
OBS2: Consegui ativar o sistema de Cache, mas a fila ficou confusa.
A rota está disponível na raiz.
Ex: /?moeda_origem=BRL&moeda_destino=USD&valor_desejado=10&data_cotacao=10/09/2019
A rota /admin/ vai conter um administrador das moedas cadastradas.
Para acessar o admin é necessário criar um usuário com o comando:
# Dentro do container dj
docker run dj python manage.py createsuper user
# Dentro no heroku
heroku run python manage.py createsuperuser -a <nome_do_projeto>Neste projeto o meu intuito é disponibilizar uma API REST que consulte a cotação do Banco do Brasil. A API recebe data_cotacao, moeda_origem, moeda_destino, valor_desejado. O retorno é valor, e data da cotacao, por que em alguns casos o Banco Central não possui histórico e pega uma data próxima.
- data_cotacao: Data para realizar a cotação.
- moeda_origem: Código da moeda origem.
- moeda_final: Código da moeda desejada.
- valor_desejado: Valor desejado de conversão.
- valor: Retorno do valor desejado.
- cotacao: Retorno da data da cotacao.
- Consegui realizar o estudo da API, utilizando o console de desenvolvedor.
- Achei todas as pontas da API e desenvolvi a solução desejada.
- Existe um robo com RabbitMQ realizando uma atualização na lista de moedas, fiz isso para tentar melhorar a performance do cliente.
Estruturar uma arquitetura que seja capaz de utilizar o serviço desenvolvido acima, com um sistema de cache (30 min).
Estruturar um sistema de Fila para consumo do serviço onde possa existir uma maneira especial de "furar_fila".
O diagrama está disponível aqui.
Nunca utilizei uma documentação como aprendi na faculdade (UML e etc.), acho que com mais convívio com isso com certeza iria pegar mais o jeito, a documentação ficou simples, porém de bonus, ativei o sistema de cache, não desenvolvi a fila, por que meu contato com RabbitMQ foi mais pra robotização, apesar de saber que o apply() de uma função pode ir para uma fila especifica.
O sistema do Cache do Django também foi algo novo, porém simples, vi que na documentação tem como ativar keys para quando for algo do cache, porém não consegui usar isso, vou continuar pesquisando sobre a condicional de quando for cache ou não, vai que até quando você ler eu achei algo :)
Para teste e desenvolvimento iremos utilizar o Docker para criar as máquinas. Clone o repositório e siga os passos abaixo.
# É necessário instalar o Docker em seu computador, e executar os comandos.
# Monte os containers que iremos utilizar
docker-compose build
# Suba os containers
docker-compose up
# Rode as migrations do Banco de Dados
docker-compose run dj python manage.py migrate
# Execute uma tarefa manual de coletar as moedas
docker-compose run dj python manage.py shell
>> from modulo_bc.tasks import get_moedas_bc
>> get_moedas_bc.apply()
# Pressione Ctrl + D para sair.A build de produção desse projeto estará disponivel no Heroku, clicando aqui. E os passos abaixo podem ser seguidos para criar o seu próprio app.
Para identificar que é uma aplicação em Python o Heroku utiliza o runtime.txt, e para identificar que é uma aplicação web com Workers utilizamos o Procfile, identificando o WSGI do Cortex como principal.
- Instale o CLI do Heroku para o seu SO. Clique aqui.
- Crie uma aplicação e selecione o deploy dela como o seu repositório Fork deste.
# Instale o sistema de gerenciamento de configurações.
heroku plugins:install heroku-config
# Envie as configurações locais do .env para seu projeto
heroku config:push -a <nome_do_projeto>
# Realize as migrações necessárias. Esse procedimento é necessário sempre que um deploy conter uma migração.
heroku run python manage.py migrate -a <nome_do_projeto>
# Baixe as moedas inicialmente
heroku run python manage.py shell
>> from modulo_bc.tasks import get_moedas_bc
>> get_moedas_bc.apply()-
Use o CloudAMPQ do Heroku
- Clique aqui para acessar a documentação.
-
Estamos utilizando um S3 da Amazon para subir os arquivos.
# Altere sua chave DEBUG para False
# O comando abaixo, gera os arquivos estáticos e os envia para um S3 na amazon.
docker run dj python manage.py collectstatic
- Configuração inicial do Django
- Configuração do Docker
- Configuração do RabbitMQ
- Configuração do Celery Service
- Verificar gerenciamento de Fila
- Gerenciamento de Cache do Django
- Verificação da API do Banco Central
- Configuração do RabbitMQ