xcode75 / paypalhttp

1.0.2 2023-05-24 12:37 UTC

README

PayPalHttp是一个通用的HTTP客户端。

在其最简单的形式中,一个HttpClient提供了一个执行方法,该方法接受一个HTTP请求,对在环境中描述的域执行它,并返回一个HTTP响应

环境

环境描述了一个托管REST API的域,对该域,HttpClient将进行请求。环境是一个简单的接口,它封装了一个方法,baseUrl

$env = new Environment('https://example.com');

请求

HTTP请求包含了执行HTTP请求所需的所有信息。具体来说,一个请求描述了一个路径、一个动词、任何路径/查询/表单参数、头信息、上传附件以及正文数据。

响应

HTTP响应包含了服务器对上述请求返回的信息。它们是简单的对象,包含状态码、头信息和服务器返回的任何数据。

$request = new HttpRequest("/path", "GET");
$request->body[] = "some data";

$response = $client->execute($req);

$statusCode = $response->statusCode;
$headers = $response->headers;
$data = $response->result;

注入器

注入器是可以用来执行任意预执行逻辑的块,例如修改请求或记录数据。注入器通过addInjector方法附加到HttpClient上。

HttpClient在每次请求之前按先入先出的顺序执行其注入器。

class LogInjector implements Injector
{
    public function inject($httpRequest)
    {
        // Do some logging here
    }
}

$logInjector = new LogInjector();
$client = new HttpClient($environment);
$client->addInjector($logInjector);
...

错误处理

HttpClient#execute如果在执行过程中出现错误,可能会抛出Exception。如果服务器返回了非200响应,将抛出IOException,其中将包含您可用于调试的状态码和头信息。

try
{
    $client->execute($req);
}
catch (HttpException $e)
{
    $statusCode = $e->response->statusCode;
    $headers = $e->response->headers;
    $body = $e->response->result;
}

许可证

PayPalHttp-PHP是开源的,可在MIT许可证下使用。有关更多信息,请参阅LICENSE文件。

贡献

欢迎拉取请求和问题。有关详细信息,请参阅CONTRIBUTING.md