# chxvxxs/coinly-converter architecture

> Architecture diagram of the GitHub repository chxvxxs/coinly-converter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-02-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chxvxxs/coinly-converter
- Repository: https://github.com/chxvxxs/coinly-converter

## Overview

##### Tipo e propósito do projeto (o que seu diagrama precisa comunicar)
Pelo `file_tree` e README, isto é um **aplicativo Java “console-based”** (não é web, não é full-stack) cujo objetivo é:
- Exibir um **menu interativo** no terminal (mín. 6 opções de conversão).
- Buscar **taxas de câmbio em tempo real** via **ExchangeRate-API** usando `java.net.http.HttpClient`.
- Fazer **parse de JSON** com **Gson**.
- Calcular e exibir o valor convertido.

Então o “sistema” aqui é pequeno, mas o diagrama pode (e deve) ser bem explícito sobre:
- **Camada de interação** (console/UI)
- **Camada de aplicação** (orquestração do fluxo)
- **Camada de integração** (HTTP client + API externa)
- **Configuração/segredos** (variável de ambiente `API_KEY_CONVERSION`)
- **Modelo/DTO de resposta** (como a resposta vira um objeto via Gson)
- **Fluxo de dados**: input do usuário → request → JSON → taxa → cálculo → output

##### O que a estrutura de arquivos indica (componentes reais)
Pelos arquivos:
- `Main.java`: entrypoint + menu + captura de input + orquestração.
- `SearchCoin.java`: integração HTTP com ExchangeRate-API.
- `Conversion.java`: parsing/extração de taxa + cálculo da conversão.

##### Diagramas recomendados (para ficar “o mais acurado possível”)
Como é um projeto pequeno, eu desenharia **2 diagramas complementares**:

##### C4 – System Context (nível 1)
Mostra o sistema e as dependências externas:
- **Usuário**
- **Aplicação Conversor de Moedas (Java CLI)**
- **ExchangeRate-API (serviço externo)**
- **Ambiente do Sistema Operacional** (onde vive `API_KEY_CONVERSION`)

Esse diagrama explica rapidamente “quem fala com quem” e quais fronteiras são externas.

Mostra as classes como componentes e o fluxo entre elas:
- `Main` (UI/Controller)
- `SearchCoin` (HTTP Gateway / External API Client)
- `Conversion` (Domain Service / Calculation + JSON parsing)
- Dependências técnicas: `HttpClient`, `Gson`

##### Componentes principais que você deve colocar no desenho
Separe em “o máximo de componentes possível” sem inventar microserviços:

**Atores/Externos**
##### OS Env Vars / Config (fonte da API key)

**Dentro do aplicativo (Java CLI)**
##### Main.java
- Menu (6 opções)
- Leitura de input (ex: `Scanner`)
- Chama `SearchCoin` e `Conversion`
- Exibe output e mensagens de erro
##### SearchCoin.java
- Monta URL (base/target ou base + rates)
- Lê `API_KEY_CONVERSION`
- Faz requisição HTTP (HttpClient)
- Retorna JSON (string) ou objeto parseado
##### Conversion.java
- Usa Gson para interpretar JSON
- Extrai taxa relevante (ex.: `USD->BRL`)
- Calcula `valorConvertido = valorEntrada * taxa`
- Devolve resultado formatado

**Bibliotecas/Infra (como caixas menores ou “anotações”)**

##### Relacionamentos e interações (setas que não podem faltar)
Modele isso com setas direcionais e rotuladas:

##### Usuário → Main
- “Seleciona opção / informa valor / moeda”
##### Main → SearchCoin
- “Solicita taxa para (base, target)”
##### SearchCoin → OS Env
- “Lê API_KEY_CONVERSION”
##### SearchCoin → ExchangeRate-API (HTTPS)
- “GET / endpoint + apiKey”
##### ExchangeRate-API → SearchCoin
- “JSON com taxas”
##### SearchCoin → Conversion
- “Entrega JSON + parâmetros (base/target/valor)” (ou “taxa” se SearchCoin já extrair)
##### Conversion → Gson
- “Parse JSON → objeto”
##### Conversion → Main
- “Retorna valor convertido / taxa usada”
##### Main → Usuário
- “Exibe resultado / erros”

Se quiser máxima precisão, acrescente fluxos alternativos (linhas tracejadas):
- Falha HTTP / sem internet
- API key ausente/inválida
- Opção inválida no menu
- Erro de parse JSON

##### Padrões/decisões arquiteturais a evidenciar (mesmo sendo simples)
- **Separação de responsabilidades por classe**:
- `Main` = interação/orquestração
- `SearchCoin` = integração com API externa
- `Conversion` = lógica de domínio (cálculo) + parsing
- **Boundary clara com serviço externo** (ExchangeRate-API)
- **Config via variáveis de ambiente** (não hardcode de segredos)
- **Dependência explícita de bibliotecas** (HttpClient/Gson)

##### Template textual de diagrama (o que você desenharia literalmente)
**Context (C4 L1):**
- [User] ⇄ (Coin Converter CLI - Java) ⇄ [ExchangeRate-API]
- (Coin Converter CLI - Java) ⇄ [OS Environment Variables: API_KEY_CONVERSION]

**Component (interno):**
- [User] → (Main.java: Menu/UI)
- (Main.java) → (SearchCoin.java: HTTP Client Wrapper)
- (SearchCoin.java) → (HttpClient)
- (HttpClient) → [ExchangeRate-API] (HTTPS)
- [ExchangeRate-API] → (HttpClient) → (SearchCoin.java)  (JSON)
- (SearchCoin.java) → (Conversion.java: Parsing + Calculation)
- (Conversion.java) → (Gson)  (parse)
- (Conversion.java) → (Main.java)  (result)
- (Main.java) → [User] (print)

##### O que NÃO colocar (para não poluir)
- Não invente camadas que não existem (ex.: “database”, “backend server”, “queue”).
- Não desenhe “microservices” — é um executável console.
- Não detalhe IDE (`.idea`) ou arquivos de projeto (`.iml`) como arquitetura runtime.

Se você seguir isso, seu diagrama ficará extremamente fiel ao projeto: um **CLI Java** com **3 classes principais**, dependências explícitas (HttpClient/Gson), **uma integração externa** (ExchangeRate-API) e configuração por **variável de ambiente** — tudo com setas claras de fluxo de dados e pontos de falha bem definidos.

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =========================
  %% C4 - System Context (L1)
  %% =========================
  subgraph "C4 • System Context (L1)"
    direction TB

    U["Usuário (Console)"]:::external

    subgraph "Sistema: Conversor de Moedas (Java CLI)"
      direction TB
      APP["Aplicação Conversor de Moedas (Java CLI)"]:::app
    end

    OS["OS Environment Variables\n(API_KEY_CONVERSION)"]:::external
    NET["Rede/Internet (HTTPS)"]:::infra
    API["ExchangeRate-API\n(Serviço Externo)"]:::external

    U -->|"seleciona_opção/informa_valor/moedas"| APP
    APP -->|"lê_API_KEY_CONVERSION"| OS
    APP -->|"GET_rates_via_HTTPS"| NET -->|"request"| API
    API -->|"JSON_taxas"| NET -->|"response"| APP
    APP -->|"exibe_resultado/erros"| U
  end

  %% =========================
  %% Component Diagram (L3 simplified)
  %% =========================
  subgraph "Componentes Internos (L3 simplificado) • Dentro do Java CLI"
    direction TB

    subgraph "Camada de Interação (Console/UI)"
      direction TB
      MAIN["Main.java\n(Menu • Input • Output • Orquestração)"]:::app
    end

    subgraph "Camada de Integração (External API Client)"
      direction TB
      SEARCH["SearchCoin.java\n(HTTP Gateway • Monta_URL • Lê_API_Key)"]:::app
    end

    subgraph "Camada de Aplicação/Domínio"
      direction TB
      CONV["Conversion.java\n(Parse_JSON • Extrai_Taxa • Calcula_Conversão)"]:::app
    end

    subgraph "Bibliotecas / Runtime"
      direction TB
      HTTP["java.net.http.HttpClient"]:::lib
      GSON["Gson"]:::lib
    end

    OS2["OS Env Vars\n(API_KEY_CONVERSION)"]:::external
    NET2["Rede/Internet (HTTPS)"]:::infra
    API2["ExchangeRate-API"]:::external
    USER2["Usuário (Console)"]:::external

    USER2 -->|"input(opção,valor,base,target)"| MAIN
    MAIN -->|"solicita_taxa(base,target)"| SEARCH
    SEARCH -->|"lê_API_KEY_CONVERSION"| OS2
    SEARCH -->|"usa"| HTTP
    HTTP -->|"GET_rates(base,target)"| NET2 -->|"request"| API2
    API2 -->|"JSON_rates"| NET2 -->|"response"| HTTP
    HTTP -->|"retorna_JSON"| SEARCH
    SEARCH -->|"entrega_JSON+parâmetros"| CONV
    CONV -->|"parse_JSON"| GSON
    CONV -->|"retorna(valor_convertido,taxa)"| MAIN
    MAIN -->|"print_resultado/erros"| USER2

    %% Fluxos alternativos (erros)
    HTTP -.->|"falha_HTTP/sem_internet"| MAIN
    SEARCH -.->|"api_key_ausente/inválida"| MAIN
    CONV -.->|"erro_parse_JSON"| MAIN
    MAIN -.->|"opção_inválida"| USER2
  end

  %% =========================
  %% Click Events (from mapping)
  %% =========================
  click APP "https://github.com/chxvxxs/coinly-converter/tree/main/coinly conversor/src/"
  click MAIN "https://github.com/chxvxxs/coinly-converter/blob/main/coinly conversor/src/Main.java"
  click SEARCH "https://github.com/chxvxxs/coinly-converter/blob/main/coinly conversor/src/SearchCoin.java"
  click CONV "https://github.com/chxvxxs/coinly-converter/blob/main/coinly conversor/src/Conversion.java"

  %% =========================
  %% Styles
  %% =========================
  classDef external fill:#ECEFF4,stroke:#4C566A,color:#2E3440,stroke-width:1px
  classDef app fill:#D6EAF8,stroke:#1F618D,color:#0B2E4A,stroke-width:1px
  classDef lib fill:#D5F5E3,stroke:#1E8449,color:#0B3D1D,stroke-width:1px
  classDef infra fill:#FDEBD0,stroke:#B9770E,color:#4A2C00,stroke-width:1px
```
