README

此开源库适用于需要具有灵活性的API调用情况，而官方SDK可能无法提供。当使用此入门套件时，您将能够通过智能管理请求和响应来执行更好的cURL请求。

安装

Composer

在您的控制台，在您的项目文件夹中，输入 composer require piggly/php-api-client；
不要忘记在您的代码库中添加Composer的自动加载文件 require_once('vendor/autoload.php');。

手动安装

使用 git clone https://github.com/piggly-dev/php-api-client.git 下载或克隆存储库；
然后，转到 cd /path/to/piggly/php-api-client；
使用 composer install 安装所有Composer依赖项；
在您的代码库中添加项目的自动加载文件 require_once('/path/to/piggly/php-api-client/vendor/autoload.php');。

依赖关系

该库有以下外部依赖关系

如何操作？

配置

此库首先提供了一个 Configuration 对象。在发送任何请求之前，您必须创建它。您可以创建多个 Configuration 对象以提供不同的环境，或者可以使用 .env 文件来管理它。

以下是所有配置

开发配置

使用 debug() 方法，您将能够启用请求调试。您还可以设置一个 Logger 以记录代码生命周期的消息。 logger() 方法期望从 monolog/monolog 包中获取 Logger。只有当设置了 Logger 时，log() 方法才会将消息输出到 Logger。

注意：调试消息仅在 debug() 模式激活时才会输出到 Logger。

请求

配置完成后，您即可使用 Request 对象。您可以将 Configuration 对象设置到 Request 构造函数中，或者它将获取默认配置。

然后，您必须从请求的方法开始： delete()、head()、get()、options()、patch()、post() 和 put()。之后，您将能够使用以下方法操作请求

当您的请求完成后，您需要使用 call() 方法。 call() 方法将

如果响应失败，抛出 ApiRequestException；
如果响应具有非 2xx 响应，抛出 ApiResponseException；
返回一个包含所有响应数据和请求引用的 Response 对象。

标题

要管理标题，有一个 HeaderBag 对象，它将包含所有处理标题所需的方法。

示例

您可以在 /samples 文件夹中看到非常轻量级的示例。

更新日志

有关所有代码更改的信息，请参阅 CHANGELOG 文件。

测试代码

此库使用 PHPUnit。我们对此应用程序的所有主要类进行测试。

vendor/bin/phpunit

您必须始终使用 PHP 7.2 和更高版本运行测试。

贡献

在提交您的贡献之前，请参阅 CONTRIBUTING 文件以获取有关信息。

致谢

支持项目

猪小工作室是一家位于巴西里约热内卢的机构。如果您喜欢这个库并想支持这项工作，请随意向以下BTC钱包地址捐赠任何金额 3DNssbspq7dURaVQH6yBoYwW3PhsNs8dnK ❤。

许可证

MIT许可证（MIT）。请参阅许可证。

piggly / php-api-client

维护者

详细信息