gsilverio7 / cep-api

API que consulta vários CEPs simultaneamente usando viaCEP.

CEP API

API que consulta vários CEPs simultaneamente usando viaCEP.

Stack utilizada

PHP, Laravel, PHPUnit, Swagger, Docker

Rodando o projeto localmente

Requisitos: PHP 8.2 com extensão pdo_sqlite habilitada

Clone o projeto

  git clone https://github.com/gsilverio7/cep-api.git

Instale as dependências

  composer install

Inicie o servidor

  php artisan serve

Rodando o projeto usando Docker

Requisitos: Docker

  docker-compose up

Rodando os testes

Para rodar os testes, rode o seguinte comando

  php artisan test

Documentação da API

Buscar CEPs

  GET /api/search/local/{ceps}

Parâmetro	Tipo	Descrição
ceps	string	Obrigatório. CEPs separados por vírgula

A documentação também está disponível de forma interativa na página inicial do projeto (localhost:8000).

Screenshots