README.md

Conversor de Moedas

Uma API REST para conversão de moedas com base na cotação do dólar americano (USD)

Preview

Este projeto pode ser acessado diretamente no Heroku.

Uso

A API suporta conversões entre as seguintes moedas:

• USD
• BRL
• EUR
• BTC
• ETH

Uma requisição válida deve fornecer como parâmetros:

• from - a moeda de origem
• to - a moeda final
• amount - o valor a ser convertido

Exemplo de Requisição

http://localhost:8000/v1/conversion?from=USD&to=BRL&amount=10

Exemplo de Retorno

{
    "result": 50.879149999999996
}

Documentação (OpenAPI)

• Swagger UI: (http://localhost:8000/docs
• Redoc: http://localhost:8000/redoc

Executando a Aplicação

Pré-requisitos

• Git
• Docker
• Python 3.10.2
• Poetry
• Make¹

¹ NOTA: A maioria das distribuições linux já disponibiliza o Make por padrão. Usuários Windows podem realizar o download aqui.

Configuração

1. Clone este repositório:

git clone [email protected]:diogo-alves/currency-converter.git

2. Acesse a pasta do repositório:

cd currency-converter

3. Instale as dependências do projeto:

make install

4. Copie o arquivo.env.example, renomeie sua cópia para .env e informe os valores das variáveis de ambiente. Para gerar a chave da API de cotações clique aqui e faça seu cadastro.

Execução

Local

make run

Em Ambiente Docker

make docker

Testes

make test

ou

make docker-test

Linters

make lint

Outros Comandos Disponíveis

Para ver a lista de todos os comandos utilitários disponíveis:

make help

Licença

Este projeto está sob os termos da licença MIT.