README

快速轻松访问任何 RESTful 或类似 RESTful 的 API。

公告

关于此库的所有更新记录在我们变更日志中。

安装

先决条件

PHP 版本 5.6 或更高

使用 Composer 安装

将 php-http-client 添加到您的 composer.json 文件。如果您不使用 Composer，您应该使用。它是管理 PHP 应用程序依赖项的绝佳方式。

{
  "require": {
    "brokeyourbike/php-http-client": "~3.10.0"
  }
}

然后在您的 PHP 脚本顶部 require 自动加载器

require __DIR__ . '/vendor/autoload.php';

然后在命令行中

composer install

快速入门

这是一个快速示例

GET /your/api/{param}/call

// include __DIR__ . '/loader.php';
require 'vendor/autoload.php';
$apiKey = YOUR_SENDGRID_API_KEY;
$authHeaders = [
    'Authorization: Bearer ' . $apiKey
];
$client = new BrokeYourBike\Client('https://api.sendgrid.com', $authHeaders);
$param = 'foo';
$response = $client->your()->api()->_($param)->call()->get();

var_dump(
    $response->statusCode(),
    $response->headers(),
    $response->body()
);

使用标头、查询参数和带有版本控制的请求体的 POST /your/api/{param}/call

// include __DIR__ . '/loader.php';
require 'vendor/autoload.php';
$apiKey = YOUR_SENDGRID_API_KEY;
$authHeaders = [
    'Authorization: Bearer ' . $apiKey
];
$client = new BrokeYourBike\Client('https://api.sendgrid.com', $authHeaders);
$queryParams = [
    'hello' => 0, 'world' => 1
];
$requestHeaders = [
    'X-Test' => 'test'
];
$data = [
    'some' => 1, 'awesome' => 2, 'data' => 3
];
$param = 'bar';
$response = $client->your()->api()->_($param)->call()->post($data, $queryParams, $requestHeaders);

var_dump(
    $response->statusCode(),
    $response->headers(),
    $response->body()
);

如果请求存在问题，例如配置错误的 CURL SSL 选项，则会抛出带有 CURL 上请求失败原因的 InvalidRequest 异常。使用该消息作为您环境故障排除步骤的线索。

用法

用法示例

路线图

如果您对此项目的未来方向感兴趣，请查看我们的里程碑。我们非常希望听到您的反馈。

如何贡献

我们鼓励向我们的库贡献，有关详细信息，请参阅我们的 CONTRIBUTING 指南。

快速链接

感谢

我们从 birdy 和 universalclient 的工作中获得了灵感。

许可协议

MIT 许可协议 (MIT)

brokeyourbike / php-http-client

维护者

详情