CEP Inspector

Esse é o repositório da Api do CEP Inspector!

Se quiser visitar o repositório do frontend é só clicar nesse link: CEP Inspector

Rotas disponíveis

Inspecionar CEP

URL estará disponível em breve!

Enquanto não está disponivel pode usar um serviço alternativo ( viaCep )

viacep.com.br/ws/{cep}/json/

Como executar na sua máquina e testar

Instalando e executando o projeto

No terminal digite todos os comandos abaixo:

git clone https://github.com/devzgabriel/api-cepInspector.git

cd api-cepInspector

yarn install

yarn knex-migrate

yarn dev

Se seu objetivo é testar o frontend, isso é tudo que precisa faser! Mas se quer usar somente a API esses são os próximos passos:

Para fazer requisições use a url abaixo e insira o número do CEP (sem traços) no lugar de "{cep}"

http://localhost:3333/inspect/{cep}

O retorno será um JSON como exemplo abaixo:

{
  "id": 6,
  "cep": "01310924",
  "logradouro": "Avenida Paulista 1912",
  "complemento": "",
  "bairro": "Bela Vista",
  "localidade": "São Paulo",
  "uf": "SP",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}

Executando testes

Os testes serão acrescentados em breve!

devzgabriel/api-cepInspector