搜索danabrey / mfl-api
用于与 MyFantasyLeague.com API 交互的 PHP 库
Requires
- php: ^7.4|^8.0
- ext-json: *
- symfony/http-client: ^5.1|^6.0|^7.0
- symfony/property-access: ^5.1|^6.0|^7.0
- symfony/serializer: ^5.1|^6.0|^7.0
Requires (Dev)
- phpunit/phpunit: ^9
README
这是一个用于与 MyFantasyLeague.com API 交互的 PHP 库。它仍在开发中，我正在积极开发它以供其他项目使用。
安装
composer require danabrey/mfl-api
用法
创建客户端实例
$client = new DanAbrey\MFLApi\MFLApiClient(2020);
需要联赛年份。你可以选择性地将 API 密钥作为第二个参数传递，以便在所有请求中使用
$client = new DanAbrey\MFLApi\MFLApiClient(2020, 'my_api_key');
使用客户端方法向 API 发送请求，例如
$client->players();
$client->league('XXXXX') 其中 XXXXX 是联赛 ID。
$client->rosters('XXXXX') 其中 XXXXX 是联赛 ID。
所有方法都返回单个实例或表示返回数据的纯 PHP 对象数组。例如 MFLPlayer、MFLRoster[] 等。
异常处理
该库抛出了一些异常，您可以根据自己的需要进行处理。它们都扩展了抽象类 DanAbrey\MFLApi\Exceptions\MFLApiException。
UnauthorizedException：API 响应告知您，该端点需要 API 密钥才能访问该数据
InvalidParametersException：API 响应包含错误提示，表明您可能忘记传递所需的参数
UnknownApiError：API 响应包含 5xx HTTP 错误，通常这意味着 MFL 端的 API 存在问题
注意
您有责任遵守 MFL API 的条款。
开发
我正在积极寻求此项目的贡献者。MFL API 是一个复杂且相当大的系统，在项目中访问其数据可能是一项繁琐的任务。该项目旨在通过自定义异常添加可靠的类型和可理解的错误处理。
如果您想参与其中，请随时提出问题。
运行测试
./vendor/bin/phpunit
树软件
此软件包采用 MIT 许可证，您可以在开源或封闭源代码项目中自由使用它。如果它进入您的生产环境，我会非常感激您为世界买下一些树。
现在众所周知，应对气候危机并防止气温升高超过 1.5C 的最佳工具之一是 种树。如果您为我的森林做出贡献，您将为当地家庭创造就业机会并恢复野生动物栖息地。
您可以在 offset.earth/treeware 购买树木。
有关 Treeware 的更多信息，请参阅 treeware.earth