Skip to content

The ViaCEP project is a Java application that consumes the public ViaCEP API to obtain address information based on the ZIP code provided by the user.

License

Notifications You must be signed in to change notification settings

camilazucchi/via-cep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Java Project: ViaCEP

Girl with a magnifying glass

Don't speak Portuguese? Click here to view this page in English.

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.

Funcionalidades

  • 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.

Como Iniciar

Para executar o aplicativo ViaCEP, siga estes passos:

  1. Clone o repositório em sua máquina local usando o comando:
git clone https://github.com/camilazucchi/ViaCEP
  1. Abra o projeto em seu ambiente de desenvolvimento Java preferido (por exemplo, IntelliJ IDEA, Eclipse ou Visual Studio Code).
  2. 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.
  3. Compile e execute a classe Main para iniciar o aplicativo.

Utilização

  1. Inicie o aplicativo ViaCEP.
  2. Digite um CEP válido do Brasil quando solicitado.
  3. O aplicativo se conectará à API ViaCEP, obterá os detalhes do endereço e os exibirá em formato estruturado.
  4. Se o CEP não for encontrato no banco de dados, uma mensagem de erro apropriada será exibida.
  5. O aplicativo também gerará um arquivo JSON chamado "address.json" contendo os detalhes do endereço para o CEP fornecido.

Dependências

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

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.

Licença

Este projeto está licenciado sob a Licença MIT — consulte o arquivo LICENSE para obter detalhes.

Autores

About

The ViaCEP project is a Java application that consumes the public ViaCEP API to obtain address information based on the ZIP code provided by the user.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages