samuelrochac/laravel-brasil-ceps

一个用于查询巴西CEPs的Laravel包,消除对外部API的依赖。

v0.3.9 2024-03-15 02:11 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

Laravel Brasil CEPs:查询和管理CEPs

Laravel Brasil CEPs 是一个用于简化在Laravel应用程序中查询和管理巴西CEPs(邮政编码)的包,提供了与巴西邮政编码数据的快速和高效集成。此包允许导入关于州、市、区和地址的数据,并提供了一个API来方便地查询CEPs。

包资源

  • 自动导入巴西州、市、区和地址的数据。
  • 灵活的配置,包括自定义表前缀。
  • 为通过CEP查询信息准备的端点。
  • 方便与现有的Laravel项目集成。

如何安装Laravel Brasil CEPs

通过Composer安装

在Laravel项目的终端中运行以下命令开始安装包

composer require samuelrochac/laravel-brasil-ceps

配置ServiceProvider

安装完成后,将 CepServiceProvider 添加到 config/app.php 文件中的 providers 数组中

'providers' => [
    // Outros Service Providers...
    Samuelrochac\LaravelBrasilCeps\CepServiceProvider::class,
],

发布配置

使用以下Artisan命令发布包的配置文件到您的Laravel项目。这允许您根据项目需求自定义配置,例如调整数据库表的前缀

php artisan vendor:publish --provider="Samuelrochac\LaravelBrasilCeps\CepServiceProvider"

发布后,brasil_ceps.php 文件将在 config 目录中可用。

自定义表前缀

要修改数据库表的标准前缀,编辑 config/brasil_ceps.php 文件

<?php

return [
    'db_prefix' => 'bzc_', // Altere conforme necessário
];

导入数据

配置完成后,使用Artisan命令将CEPs数据导入到您的数据库中

php artisan import:zipcodes

测试CEP查询端点

要验证包的功能和CEP查询,请访问

http://seu_dominio.com/api/cep/01423010/json

seu_dominio.com 替换为您Laravel应用程序正在运行的域名或IP。

贡献和支持

欢迎贡献。要贡献,请fork存储库,为您的功能或修复创建一个分支,然后提交一个pull request。

要报告错误或请求新功能,请打开GitHub上的一个问题。

许可

此包根据MIT许可证分发。有关更多信息,请参阅包含在源代码中的 LICENSE 文件。