alexjustesen/php-openbrewerydb

Open Brewery DB 的非官方 PHP SDK

v0.3.0 2023-03-06 20:13 UTC

This package is auto-updated.

Last update: 2024-09-06 23:21:12 UTC


README

PHP SDK for Open Brewery DB api.

赞助商

喜欢这个包吗?考虑 赞助 我以帮助我实现目标。

安装

composer require alexjustesen/php-openbrewerydb

用法

身份验证

OpenBreweryDB API 的 v1 版本没有强制执行任何身份验证模式,但是存在速率限制。

初始化请求

要开始,请创建 SDK 的新实例。

$obdb = new OpenBreweryDb;

处理响应

SDK 使用 Sam Carre 的 Saloon,在发送请求后,您可以使用任何已记录的方法与响应交互,例如 ->body()->json()

在下面的示例中,我们请求一个单一酒厂并将响应格式化为 json。

$request = new GetBrewery('brewery-id-goes-here');

$response = $obdb->send($request);

$response->json();

列出酒厂

$request = new ListBreweries();

$response = $obdb->send($request);

其他用于过滤结果的方法

  • $request->filterByCity('hartford') - string
  • $request->filterByName('broad brook') - string
  • $request->filterByPostal('06002') - string
  • $request->filterByState('connecticut') - string
  • $request->filterByType('micro') - string

其他用于排序结果的方法

  • $request->sortBy('type,name:asc') - stringarray
  • $request->sortByDistance(41.96200785, -72.66266463) - $lat: float, $lon: float

获取酒厂

$request = new GetBrewery('brewery-id-goes-here');

$response = $obdb->send($request);

获取随机酒厂

$request = new GetRandomBrewery();

$response = $obdb->send($request);

可用参数

  • size,默认 = 1

搜索酒厂

$request = new SearchBreweries('dog');

$response = $obdb->send($request);

自动完成酒厂

$request = new AutocompleteBreweries('dog');

$response = $obdb->send($request);

测试

使用 PHP CS Fixer

PHP_CS_FIXER_IGNORE_ENV=1 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src --allow-risky=yes

使用 Pest

./vendor/bin/pest
``