gabrielmoura/laravel-cep

A simple Laravel package to get CEP information

1.0 2023-12-09 17:57 UTC

Requires

• php: ^8.2
• illuminate/http: *

Requires (Dev)

• laravel/pint: ^1.13
• orchestra/testbench: ^8.0
• phpstan/phpstan: ^1.10

Suggests

• illuminate/redis: ^v10

MIT

• Gabriel Moura

• redis
• laravel
• cep

README

A comprehensive Laravel package for fetching Brazilian zip code (CEP) information from multiple providers, offering seamless caching and flexibility.

Features

• Multiple Providers: Integrates with:
  • ViaCEP
  • Postmon
  • Open CEP
  • Brasil API
• Intelligent Caching: Streamlines performance with optional Redis caching.
• Ease of Use: Simple interface via container or facade.
• Customizable: Configure the preferred provider.

Installation

composer require gabrielmoura/laravel-cep

Configuration

Publish the configuration file (optional):

php artisan vendor:publish --provider="Gabrielmoura\LaravelCep\CepServiceProvider"

In your config/services.php, adjust the default provider if desired:

'cep' => [
   'endpoint' => \Gabrielmoura\LaravelCep\EndpointOption::POSTMON, // Example: Change to your preferred provider
],

Strongly consider installing illuminate/redis for automatic caching.

Usage

Container:

use Gabrielmoura\LaravelCep\CepService;
$cepData = app(CepService::class)->find('01001000', true); // Enable caching

Facade:

use Gabrielmoura\LaravelCep\Cep;
$cepData = Cep::find('01001000', true); // Enable caching

Compatibility

• Laravel 10.x

Contributing

We welcome contributions! Please refer to our CONTRIBUTING.md

License

Laravel CEP is released under the MIT License.