Code Monkey home page Code Monkey logo

cep-api's Introduction

ViaCEP Java API

Este é um repositório para uma API Java que permite buscar informações de CEP ou endereço utilizando o serviço gratuito ViaCEP.

Introdução

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.

Funcionalidades

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.

Instalação

Para executar esta API Java localmente, siga as instruções abaixo:

Pré-requisitos

  • Java Development Kit (JDK) 17 ou posterior
  • Apache Maven

Passos

  1. Clone o repositório em sua máquina local:
git clone https://github.com/laramt/cep-api.git
  1. Importe o projeto na sua IDE preferida

  2. Verifique se as configurações de porta e URL do serviço ViaCEP estão corretas.

  3. Construa o projeto usando o Maven e execute a aplicação.

Como usar

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.

Contato

Se você tiver alguma dúvida ou feedback sobre a API ViaCEP Java, sinta-se à vontade para entrar em contato aqui.

cep-api's People

Contributors

laramt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.