🚀 5.2 Conheça a Estrutura de uma API REST
Assim como fizemos com o Google Books, o primeiro contato com qualquer API deve ser via navegador ou ferramentas de teste como o Postman ou Insomnia. Isso permite validar se o servidor está respondendo corretamente antes de escrevermos uma única linha de código.
Inspecionando o JSON
Ao acessar uma URL de API (ex: https://www.googleapis.com/books/v1/volumes?q=android), o navegador pode exibir um texto bruto e difícil de ler. Para uma análise profissional, utilizamos o JSONLint ou as ferramentas integradas do Android Studio.
O que procurar em um JSON?
Independente da API (Twitter, Google, GitHub), você deve identificar quatro elementos fundamentais para mapear seus objetos Java:
- Coleções (
Arrays): Representados por[]. No Java, mapeamos paraList<T>. - Objetos: Representados por
{}. No Java, mapeamos para umaclassouRecord. - Metadados: Informações sobre a busca (ex:
totalItems,kind). - Chaves Primárias: Identificadores únicos (
id) fundamentais para CRUDs.
Mapeamento de Atributos
Imagine que estamos consultando uma API de Viagens. Identificaríamos os seguintes atributos no JSON para nossa classe Viagem:
destino: Nome da cidade (String).orcamento: Valor total (Double).tipo: Categoria da viagem (Integer).
IMPORTANT
API Keys e Segurança: A maioria das APIs modernas exige uma API Key para identificação. Jamais coloque essas chaves diretamente no código (hardcoded). Utilize o arquivo
local.propertiese acesse-as via BuildConfig.
TIP
No Android Studio 2023.1, a aba App Inspection > Network Inspector permite visualizar todo o tráfego JSON entre seu app e o servidor, exibindo os dados já formatados e com destaque de sintaxe, dispensando o uso de validadores externos.