Giter VIP home page Giter VIP logo

api-cep's Introduction

CEP-API

O objetivo do teste é criar uma aplicação API Rest em Java de consulta de CEP.

Técnologias utilizadas

- Java 11
- Spring Boot
- Hibernate
- PostgreSQL

Instalação e requisitos

Requisitos

Docker

Docker

    $ docker-compose up --build

Rotas

Cep - Obter um único CEP

Tipo: GET
Url: {contexto}/cep/{cep}
Exemplo: http://localhost:8080/cep/01001000

Caso o CEP não exista, consultar o site http://viacep.com.br/ e realizar o cadastro do cep e da cidade.

Retorno

{
    "cep": "01001-010",
    "logradouro": "Rua Filipe de Oliveira",
    "complemento": "",
    "bairro": "Sé",
    "cidade": {
        "ibge": "3550308",
        "uf": "SP",
        "localidade": "São Paulo"
    }
}

Cep - Obter a lista de CEPs de uma cidade.

Tipo: GET
Url: {contexto}/ceps
Parâmetros: ibge (obrigatório) e uf
Exemplo: http://localhost:8080/ceps?ibge=3550308&uf=SP

Retorno

[
    {
        "cep": "01001-010",
        "logradouro": "Rua Filipe de Oliveira",
        "complemento": "",
        "bairro": "Sé",
        "cidade": {
            "ibge": "3550308",
            "uf": "SP",
            "localidade": "São Paulo"
        }
    },
    {
        "cep": "01001-000",
        "logradouro": "Praça da Sé",
        "complemento": "lado ímpar",
        "bairro": "Sé",
        "cidade": {
            "ibge": "3550308",
            "uf": "SP",
            "localidade": "São Paulo"
        }
    }
]

Rotas no Postman

Run in Postman

api-cep's People

Contributors

gabriellhuver avatar elenowine avatar

Watchers

James Cloos 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.