README

简单的PSR-18 HTTP客户端库。

安装

composer require nimbly/shuttle

特性

• 响应创建php://temp响应体流，并在必要时切换到磁盘。
• 支持cURL（默认）和Stream Context处理器。
• 开箱即用的中间件支持。
• 使用JsonBody、FormBody和XmlBody辅助类创建请求时，易于进行请求体转换。

不支持的功能

• 异步调用。

轻松发送请求：简单的方法

在Shuttle中开始发送请求最快、最简单的方法是使用HTTP方法名称

use Nimbly\Shuttle\Shuttle;

$shuttle = new Shuttle;

$response = $shuttle->get("https://www.google.com");
$response = $shuttle->post("https://example.com/search", "Form data"));

Shuttle内置方法支持主要的HTTP动词：get、post、put、patch、delete、head和options。然而，您可以直接使用request方法发送任何HTTP动词请求。

$response = $shuttle->request("connect", "https://api.example.com/v1/books");

处理响应

Shuttle中的响应实现PSR-7 ResponseInterface，因此是可流式传输的资源。

$response = $shuttle->get("https://api.example.com/v1/books");

echo $response->getStatusCode(); // 200
echo $response->getReasonPhrase(); // OK
echo $response->isSuccessful(); // true

$body = $response->getBody()->getContents();

处理失败的请求

如果请求失败，Shuttle默认会抛出RequestException。这包括诸如主机名不存在、连接超时等问题。

具有HTTP 4xx或5xx状态码的响应不会抛出异常，必须在您的业务逻辑中正确处理。

轻松发送请求：PSR-7方法

如果您重视代码的可重用性和可移植性，请通过PSR-7方法发送请求，以确保代码的长期有效性。请记住，PSR-7规定请求和响应消息必须是不可变的。

// Build Request message with your favorite PSR-7 library.
$request = new Request("get", "https://www.example.com");

// Send the Request.
$shuttle = new Shuttle;
$response = $shuttle->sendRequest($request);

请求体

使用\Shuttle\Body\*辅助类提交数据是提交请求的一种简单方法。这些类将自动转换数据，转换为BufferStream，并在请求上设置默认的Content-Type头。

请求体支持包括

• JsonBody 将关联数组转换为JSON，将Content-Type头设置为application/json。
• FormBody 将关联数组转换为查询字符串，将Content-Type头设置为application/x-www-form-urlencoded。
• XmlBody 不转换数据，将Content-Type头设置为application/xml。

提交带有请求的JSON有效负载

use Nimbly\Shuttle\Body\JsonBody;

$book = [
    "title" => "Breakfast Of Champions",
    "author" => "Kurt Vonnegut",
];

$shuttle->post("https://api.example.com/v1/books", new JsonBody($book));