O Projeto ViaCEP é uma aplicação Java que interage com a API pública do ViaCEP para obter informações detalhadas de endereços com base no CEP fornecido pelo usuário. O objetivo do projeto é aprender sobre o consumo de API com Java.
- Informar um CEP e obter detalhes do endereço, incluindo rua, bairro, cidade e estado.
- Tratar casos em que o CEP fornecido não é encontrado no banco de dados e exibir mensagens de erro adequadas.
- Utilizar a biblioteca Gson para fazer o parsing das respostas JSON da API ViaCEP em objetos Java.
- Implementar exceções personalizadas para tratar erros específicos e fornecer mensagens de erro informativas.
Para executar o aplicativo ViaCEP, siga estes passos:
- Clone o repositório em sua máquina local usando o comando:
git clone https://github.com/camilazucchi/ViaCEP
- Abra o projeto em seu ambiente de desenvolvimento Java preferido (por exemplo, IntelliJ IDEA, Eclipse ou Visual Studio Code).
- Certifique-se de que a biblioteca Gson (com.google.code.gson) esteja adicionada ao classpath do projeto. Caso contrário, faça o download do arquivo JARD do Gson e inclua-o no projeto.
- Compile e execute a classe Main para iniciar o aplicativo.
- Inicie o aplicativo ViaCEP.
- Digite um CEP válido do Brasil quando solicitado.
- O aplicativo se conectará à API ViaCEP, obterá os detalhes do endereço e os exibirá em formato estruturado.
- Se o CEP não for encontrato no banco de dados, uma mensagem de erro apropriada será exibida.
- O aplicativo também gerará um arquivo JSON chamado "address.json" contendo os detalhes do endereço para o CEP fornecido.
O Projeto ViaCEP requer a seguinte biblioteca:
- Gson (com.google.code.gson): Uma biblioteca para fazer o parsing de dados JSON em objetos Java e vice-versa.
Contribuições para o Projeto ViaCEP são bem-vindas. Se encontrar algum bug, tiver sugestões de melhorias ou quiser adicionar novas funcionalidades, sinta-se à vontade para abrir uma issue ou enviar um pull request.
Este projeto está licenciado sob a Licença MIT — consulte o arquivo LICENSE para obter detalhes.