roelofr / postcodeapi
此包已被弃用且不再维护。没有建议的替代包。
这是一个简单的Laravel服务,通过postcodeapi.nu提供邮政编码验证。
v0.2.2
2020-01-23 10:54 UTC
Requires
- php: >=7.4
- guzzlehttp/guzzle: ^6.5 | ^7.0
- illuminate/cache: ^5.1 | ^6.0
- illuminate/support: ^5.1 | ^6.0
- illuminate/validation: ^5.1 | ^6.0
Requires (Dev)
- minimaxir/big-list-of-naughty-strings: ^1.0
- nesbot/carbon: ^2.28
- orchestra/testbench: ^3.1 | ^4.0
- phpunit/phpunit: ^7.0
- squizlabs/php_codesniffer: ^3.2
This package is auto-updated.
Last update: 2022-07-17 00:47:51 UTC
README
通过简单易用、经过良好测试的Laravel插件轻松访问postcodeapi.nu。
许可证
要求
- PHP 7.4+
- Laravel 5.1(支持Statamic)
安装
- 首先,从Packagist拉取插件
composer require roelofr/postcodeapi
- (Laravel <5.5) 将服务提供者添加到
config/app.php
'providers' => [ // … Roelofr\PostcodeApi\ServiceProvider::class ]
- 发布配置
php artian vendor:publish --provider=Roelofr\PostcodeApi\ServiceProvider
- 一切准备就绪!
使用方法
此插件提供了一个合同(PostcodeApiContract
)和一个外观(PostcodeApi
),您可以使用任意一个。
主要路由是 retrieve
方法,它期望一个邮政编码和一个数字。
public function retrieve(string $postcode, string $number): AddressInformation;
该方法将自动尝试清理邮政编码和数字,以便进行API提交。检索后,将返回AddressInformation模型,或抛出NotFoundException
。
异常
- 如果我们在参数中找不到荷兰的邮政编码和门牌号,将抛出
MalformedDataException
。 - 如果您的API密钥无效,将抛出
AuthenticationFailureException
。 - 如果给定的邮政编码 + 数字找不到,将抛出
NotFoundException
。
不使用Laravel
在没有Laravel的情况下使用此插件相当棘手,因为它需要根据Laravel的方案进行配置和缓存。
如果您想重写部分代码以使其在没有Laravel的情况下工作,请随时提交PR。但这有些超出了范围。