Este é um repositório para uma API Java que permite buscar informações de CEP ou endereço utilizando o serviço gratuito ViaCEP.
A ViaCEP Java API é uma aplicação Java que permite buscar informações de CEP ou endereço utilizando o serviço gratuito ViaCEP. Ela utiliza o Spring Framework para criar uma API RESTful simples e fácil de usar.
As seguintes funcionalidades estão disponíveis nesta API:
- Busca de informações de CEP por número do CEP.
- Busca de informações de endereços por UF, localidade e logradouro.
Para executar esta API Java localmente, siga as instruções abaixo:
- Java Development Kit (JDK) 17 ou posterior
- Apache Maven
- Clone o repositório em sua máquina local:
git clone https://github.com/laramt/cep-api.git
-
Importe o projeto na sua IDE preferida
-
Verifique se as configurações de porta e URL do serviço ViaCEP estão corretas.
-
Construa o projeto usando o Maven e execute a aplicação.
Esta API possui dois endpoints disponíveis:
GET /cep/{cep}
: Busca informações por um CEP expecifico.GET /endereco/{uf}/{localidade}/{logradouro}
: Busca informações de endereço com base nos parâmetros informados (UF, localidade e logradouro)
Exemplo de uso:
GET /cep/01001000
GET /endereco/SP/São+Paulo/Avenida+Paulista
GET /endereco/SP/São%20Paulo/Avenida%20Paulista
A resposta será um objeto JSON contendo as informações do endereço.
Se você tiver alguma dúvida ou feedback sobre a API ViaCEP Java, sinta-se à vontade para entrar em contato aqui.