https://github.com/flc1125/http

HTTP
https://github.com/flc1125/http

Last synced: 17 days ago
JSON representation

HTTP

• Host: GitHub
• URL: https://github.com/flc1125/http
• Owner: flc1125
• License: mit
• Created: 2020-07-21T12:55:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-27T03:46:31.000Z (over 4 years ago)
• Last Synced: 2024-11-30T10:43:30.811Z (22 days ago)
• Language: PHP
• Size: 23.4 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PHP HTTP 客户端

> 该扩展基于 Laravel 的 [illuminate/http ](https://github.com/illuminate/http) 扩展进行简化独立而得，核心源码更多为官方源码。

## 安装

```

composer require flc\http

```

> 非稳定版，请勿用于生产

## 使用

> 使用文档，拷贝官方的，:sweat_smile: :sweat_smile:

### 创建请求

你可以通过 `get`、 `post`、 `put`、 `patch` 和 `delete` 方法来创建请求。首先，让我们先看一下如何发出一个基础的 `GET` 请求：

```php

body() : string;

$response->json() : array;

$response->status() : int;

$response->ok() : bool;

$response->successful() : bool;

$response->serverError() : bool;

$response->clientError() : bool;

$response->header($header) : string;

$response->headers() : array;

```

`Flc\Http\Response` 对象同样实现了 PHP 的 `ArrayAccess` 接口，这代表着你可以直接访问响应的 JSON 数据。

```php

 'Steve',

    'role' => 'Network Administrator',

]);

```

### 发送 URL 编码的请求

如果你希望使用 `application/x-www-form-urlencoded` 作为请求的数据类型，你可以在创建请求前调用 `asForm` 方法：

```php

post('http://test.com/users', [

    'name' => 'Sara',

    'role' => 'Privacy Consultant',

]);

```

### 发送 Multipart 请求

如果你希望将文件作为 Multipart 请求发送，你应该在创建请求前调用 `attach` 方法。该方法接受文件的标识符（相当于 HTML Input 的 `name` 属性）以及其内容。你也可以在第三个参数传入自定义的文件名称，这不是必须的。

```php

post('http://test.com/attachments');

```

除了传递文件的原始内容，你也可以传递 `Stream` 流数据：

```php

post('http://test.com/attachments');

```

### 请求头

你可以通过 `withHeaders` 方法添加请求头。该方法接受一个数组格式的键值对。

```php

 'foo',

    'X-Second' => 'bar'

])->post('http://test.com/users', [

    'name' => 'Taylor',

]);

```

### 认证

你可以使用 `withBasicAuth` 和 `withDigestAuth` 方法来分别指定使用 `basic` 或是 `digest` 认证方式：

```php

post(...);

// Digest 认证...

$response = Client::withDigestAuth('[email protected]', 'secret')->post(...);

```

### Bearer Token（Token 令牌）

如果你想要为你的请求快速添加 `Authorization` Token 令牌请求头，你可以使用 `withToken` 方法：

```php

post(...);

```

### 重试

如果你希望你的 HTTP 客户端在发生错误时自动重新发送请求，你可以使用 `retry` 方法。该方法接受两个参数：重新尝试次数以及重试等待时间（毫秒）：

```php

post(...);

```

如果所有的请求都失败了，`Flc\Http\RequestException` 异常将会被抛出。

### 错误处理

跟 Guzzle 的默认行为不同，Laravel HTTP 客户端并不会在客户端或服务端错误时抛出异常（`400` 及 `500` 状态码）。你可以通过 `successful`、 `clientError` 或是 `serverError` 方法来判断是否发生错误：

```php

successful();

// 确认是否发生了 400 级别的错误（以 4 开头的状态码）

$response->clientError();

// 确认是否发生了 500 级别的错误（以 5 开头的状态码）

$response->serverError();

```

### 抛出异常

如果你希望请求在发生客户端或服务端错误时抛出 `Flc\Http\RequestException` 异常，你可以在请求实例上调用 `throw` 方法：

```php

throw();

return $response['user']['id'];

```

`Flc\Http\RequestException` 实例拥有一个 `$response` 公共属性，该属性允许你检查返回的响应。

如果没有发生错误，`throw` 方法将返回响应实例，你可以在其上进行其他操作：

```php

throw()->json();

```

## LICENSE

MIT