HTTPクライアント

イントロダクション
リクエストの実行
並行リクエスト
マクロ
テスト
イベント

イントロダクション

Laravelは、Guzzle HTTPクライアントをラップした、表現力豊かで最小限のAPIを提供し、他のWebアプリケーションと通信するためのHTTPリクエストを素早く送信できるようにします。LaravelのGuzzleラッパーは、最も一般的な使用例と素晴らしい開発者体験に焦点を当てています。

リクエストの実行

リクエストを行うには、Httpファサードが提供するhead、get、post、put、patch、deleteメソッドを使用します。まず、他のURLへ基本的なGETリクエストを行う方法を見ていきましょう。

1use Illuminate\Support\Facades\Http;
2 
3$response = Http::get('http://example.com');

use Illuminate\Support\Facades\Http;

$response = Http::get('http://example.com');

getメソッドはIlluminate\Http\Client\Responseのインスタンスを返します。これには、レスポンスを検査するために使用できるさまざまなメソッドが用意されています。

 1$response->body() : string;
 2$response->json($key = null, $default = null) : mixed;
 3$response->object() : object;
 4$response->collect($key = null) : Illuminate\Support\Collection;
 5$response->resource() : resource;
 6$response->status() : int;
 7$response->successful() : bool;
 8$response->redirect(): bool;
 9$response->failed() : bool;
10$response->clientError() : bool;
11$response->header($header) : string;
12$response->headers() : array;

$response->body() : string;
$response->json($key = null, $default = null) : mixed;
$response->object() : object;
$response->collect($key = null) : Illuminate\Support\Collection;
$response->resource() : resource;
$response->status() : int;
$response->successful() : bool;
$response->redirect(): bool;
$response->failed() : bool;
$response->clientError() : bool;
$response->header($header) : string;
$response->headers() : array;

Illuminate\Http\Client\Responseオブジェクトは、PHPのArrayAccessインターフェイスも実装しているため、レスポンスのJSONレスポンスデータへ直接アクセスできます。

1return Http::get('http://example.com/users/1')['name'];

return Http::get('http://example.com/users/1')['name'];

上記のレスポンスメソッドに加えて、レスポンスが特定のステータスコードであるかを判定するために、以下のメソッドが使用できます。

 1$response->ok() : bool;                  // 200 OK
 2$response->created() : bool;             // 201 Created
 3$response->accepted() : bool;            // 202 Accepted
 4$response->noContent() : bool;           // 204 No Content
 5$response->movedPermanently() : bool;    // 301 Moved Permanently
 6$response->found() : bool;               // 302 Found
 7$response->badRequest() : bool;          // 400 Bad Request
 8$response->unauthorized() : bool;        // 401 Unauthorized
 9$response->paymentRequired() : bool;     // 402 Payment Required
10$response->forbidden() : bool;           // 403 Forbidden
11$response->notFound() : bool;            // 404 Not Found
12$response->requestTimeout() : bool;      // 408 Request Timeout
13$response->conflict() : bool;            // 409 Conflict
14$response->unprocessableEntity() : bool; // 422 Unprocessable Entity
15$response->tooManyRequests() : bool;     // 429 Too Many Requests
16$response->serverError() : bool;         // 500 Internal Server Error

$response->ok() : bool;                  // 200 OK
$response->created() : bool;             // 201 Created
$response->accepted() : bool;            // 202 Accepted
$response->noContent() : bool;           // 204 No Content
$response->movedPermanently() : bool;    // 301 Moved Permanently
$response->found() : bool;               // 302 Found
$response->badRequest() : bool;          // 400 Bad Request
$response->unauthorized() : bool;        // 401 Unauthorized
$response->paymentRequired() : bool;     // 402 Payment Required
$response->forbidden() : bool;           // 403 Forbidden
$response->notFound() : bool;            // 404 Not Found
$response->requestTimeout() : bool;      // 408 Request Timeout
$response->conflict() : bool;            // 409 Conflict
$response->unprocessableEntity() : bool; // 422 Unprocessable Entity
$response->tooManyRequests() : bool;     // 429 Too Many Requests
$response->serverError() : bool;         // 500 Internal Server Error

URIテンプレート

HTTPクライアントでは、URIテンプレート仕様を使用してリクエストURLを構築することもできます。URIテンプレートで展開できるURLパラメータを定義するには、withUrlParametersメソッドを使用します。

1Http::withUrlParameters([
2    'endpoint' => 'https://laravel.dokyumento.jp',
3    'page' => 'docs',
4    'version' => '11.x',
5    'topic' => 'validation',
6])->get('{+endpoint}/{page}/{version}/{topic}');

Http::withUrlParameters([
    'endpoint' => 'https://laravel.dokyumento.jp',
    'page' => 'docs',
    'version' => '11.x',
    'topic' => 'validation',
])->get('{+endpoint}/{page}/{version}/{topic}');

リクエストのダンプ

送信前の送信リクエストインスタンスをダンプし、スクリプトの実行を終了させたい場合は、リクエスト定義の先頭にddメソッドを追加してください。

1return Http::dd()->get('http://example.com');

return Http::dd()->get('http://example.com');

リクエストデータ

もちろん、POST、PUT、PATCHリクエストを行う際には、リクエストとともに追加のデータを送信することが一般的です。そのため、これらのメソッドは第2引数としてデータの配列を受け取ります。デフォルトでは、データはapplication/jsonコンテントタイプを使用して送信されます。

1use Illuminate\Support\Facades\Http;
2 
3$response = Http::post('http://example.com/users', [
4    'name' => 'Steve',
5    'role' => 'Network Administrator',
6]);

use Illuminate\Support\Facades\Http;

$response = Http::post('http://example.com/users', [
    'name' => 'Steve',
    'role' => 'Network Administrator',
]);

GETリクエストのクエリパラメータ

GETリクエストを行う際、URLに直接クエリ文字列を追加するか、getメソッドの第２引数としてキー／値のペアの配列を渡すことができます。

1$response = Http::get('http://example.com/users', [
2    'name' => 'Taylor',
3    'page' => 1,
4]);

$response = Http::get('http://example.com/users', [
    'name' => 'Taylor',
    'page' => 1,
]);

あるいは、withQueryParametersメソッドを使用することもできます。

1Http::retry(3, 100)->withQueryParameters([
2    'name' => 'Taylor',
3    'page' => 1,
4])->get('http://example.com/users')

Http::retry(3, 100)->withQueryParameters([
    'name' => 'Taylor',
    'page' => 1,
])->get('http://example.com/users')

Form URLエンコードリクエストの送信

application/x-www-form-urlencodedコンテントタイプを使用してデータを送信したい場合は、リクエストを行う前にasFormメソッドを呼び出す必要があります。

1$response = Http::asForm()->post('http://example.com/users', [
2    'name' => 'Sara',
3    'role' => 'Privacy Consultant',
4]);

$response = Http::asForm()->post('http://example.com/users', [
    'name' => 'Sara',
    'role' => 'Privacy Consultant',
]);

Rawリクエストボディの送信

リクエストを行う際に素の(raw)リクエストボディを提供したい場合は、withBodyメソッドを使用します。コンテントタイプは、メソッドの第2引数で指定できます。

1$response = Http::withBody(
2    base64_encode($photo), 'image/jpeg'
3)->post('http://example.com/photo');

$response = Http::withBody(
    base64_encode($photo), 'image/jpeg'
)->post('http://example.com/photo');

マルチパートリクエスト

ファイルをマルチパートリクエストとして送信したい場合は、リクエストを行う前にattachメソッドを呼び出す必要があります。このメソッドは、ファイルの名前とその内容を引数に取ります。必要であれば、第３引数にファイル名とみなす値を指定でき、第４引数でファイルに関連付けるヘッダを渡せます。

1$response = Http::attach(
2    'attachment', file_get_contents('photo.jpg'), 'photo.jpg', ['Content-Type' => 'image/jpeg']
3)->post('http://example.com/attachments');

$response = Http::attach(
    'attachment', file_get_contents('photo.jpg'), 'photo.jpg', ['Content-Type' => 'image/jpeg']
)->post('http://example.com/attachments');

ファイルの素の内容を渡す代わりに、ストリームリソースを渡すこともできます。

1$photo = fopen('photo.jpg', 'r');
2 
3$response = Http::attach(
4    'attachment', $photo, 'photo.jpg'
5)->post('http://example.com/attachments');

$photo = fopen('photo.jpg', 'r');

$response = Http::attach(
    'attachment', $photo, 'photo.jpg'
)->post('http://example.com/attachments');

ヘッダ

リクエストにヘッダを追加するにはwithHeadersメソッドを使用します。このwithHeadersメソッドは、キー／値ペアの配列を引数に取ります。

1$response = Http::withHeaders([
2    'X-First' => 'foo',
3    'X-Second' => 'bar'
4])->post('http://example.com/users', [
5    'name' => 'Taylor',
6]);

$response = Http::withHeaders([
    'X-First' => 'foo',
    'X-Second' => 'bar'
])->post('http://example.com/users', [
    'name' => 'Taylor',
]);

acceptメソッドを使用して、アプリケーションがリクエストへのレスポンスとして期待するコンテントタイプを指定できます。

1$response = Http::accept('application/json')->get('http://example.com/users');

$response = Http::accept('application/json')->get('http://example.com/users');

利便性のために、acceptJsonメソッドを使用して、アプリケーションがリクエストへのレスポンスとしてapplication/jsonコンテントタイプを期待することを素早く指定できます。

1$response = Http::acceptJson()->get('http://example.com/users');

$response = Http::acceptJson()->get('http://example.com/users');

withHeadersメソッドは、新しいヘッダをリクエストの既存のヘッダにマージします。必要であれば、replaceHeadersメソッドを使用して、すべてのヘッダを完全に置き換えることもできます。

1$response = Http::withHeaders([
2    'X-Original' => 'foo',
3])->replaceHeaders([
4    'X-Replacement' => 'bar',
5])->post('http://example.com/users', [
6    'name' => 'Taylor',
7]);

$response = Http::withHeaders([
    'X-Original' => 'foo',
])->replaceHeaders([
    'X-Replacement' => 'bar',
])->post('http://example.com/users', [
    'name' => 'Taylor',
]);

認証

Basic認証とDigest認証の認証情報をそれぞれwithBasicAuthメソッドとwithDigestAuthメソッドで指定できます。

1// Basic authentication...
2$response = Http::withBasicAuth('[email protected]', 'secret')->post(/* ... */);
3 
4// Digest authentication...
5$response = Http::withDigestAuth('[email protected]', 'secret')->post(/* ... */);

// Basic authentication...
$response = Http::withBasicAuth('[email protected]', 'secret')->post(/* ... */);

// Digest authentication...
$response = Http::withDigestAuth('[email protected]', 'secret')->post(/* ... */);

Bearerトークン

リクエストのAuthorizationヘッダにBearerトークンを素早く追加したい場合は、withTokenメソッドを使用します。

1$response = Http::withToken('token')->post(/* ... */);

$response = Http::withToken('token')->post(/* ... */);

タイムアウト

timeoutメソッドを使用して、レスポンスを待つ最大秒数を指定できます。デフォルトでは、HTTPクライアントは30秒後にタイムアウトします。

1$response = Http::timeout(3)->get(/* ... */);

$response = Http::timeout(3)->get(/* ... */);

指定したタイムアウトを超えた場合、Illuminate\Http\Client\ConnectionExceptionのインスタンスが投げられます。

サーバへの接続を試みる際に待機する最大秒数をconnectTimeoutメソッドで指定できます。

1$response = Http::connectTimeout(3)->get(/* ... */);

$response = Http::connectTimeout(3)->get(/* ... */);

リトライ

クライアントエラーまたはサーバーエラーが発生した場合にHTTPクライアントにリクエストを自動的に再試行させたい場合は、retryメソッドを使用できます。retryメソッドは、リクエストを試行する最大回数と、Laravelが試行の間に待機するミリ秒数を引数に取ります。

1$response = Http::retry(3, 100)->post(/* ... */);

$response = Http::retry(3, 100)->post(/* ... */);

試行の間にスリープするミリ秒数を手動で計算したい場合は、retryメソッドの第2引数としてクロージャを渡してください。

1use Exception;
2 
3$response = Http::retry(3, function (int $attempt, Exception $exception) {
4    return $attempt * 100;
5})->post(/* ... */);

use Exception;

$response = Http::retry(3, function (int $attempt, Exception $exception) {
    return $attempt * 100;
})->post(/* ... */);

利便性のために、retryメソッドの第1引数に配列を指定することもできます。この配列は、後続の試行の間に何ミリ秒スリープするかを決定するために使用されます。

1$response = Http::retry([100, 200])->post(/* ... */);

$response = Http::retry([100, 200])->post(/* ... */);

必要であれば、retryメソッドに第３引数を渡せます。第３引数は、再試行を実際に試みるべきかを判定する呼び出し可能(callable)なクロージャを指定します。例えば、最初のリクエストでConnectionExceptionが発生した場合にのみリクエストを再試行したい場合などです。

1use Exception;
2use Illuminate\Http\Client\PendingRequest;
3 
4$response = Http::retry(3, 100, function (Exception $exception, PendingRequest $request) {
5    return $exception instanceof ConnectionException;
6})->post(/* ... */);

use Exception;
use Illuminate\Http\Client\PendingRequest;

$response = Http::retry(3, 100, function (Exception $exception, PendingRequest $request) {
    return $exception instanceof ConnectionException;
})->post(/* ... */);

リクエストの試行が失敗した場合、新しい試行を行う前にリクエストに変更を加えたい場合があります。これは、retryメソッドに提供したクロージャに渡されるリクエスト引数を変更することで実現できます。たとえば、最初の試行で認証エラーが返された場合、新しい認証トークンでリクエストを再試行したい場合があります。

 1use Exception;
 2use Illuminate\Http\Client\PendingRequest;
 3use Illuminate\Http\Client\RequestException;
 4 
 5$response = Http::withToken($this->getToken())->retry(2, 0, function (Exception $exception, PendingRequest $request) {
 6    if (! $exception instanceof RequestException || $exception->response->status() !== 401) {
 7        return false;
 8    }
 9 
10    $request->withToken($this->getNewToken());
11 
12    return true;
13})->post(/* ... */);

use Exception;
use Illuminate\Http\Client\PendingRequest;
use Illuminate\Http\Client\RequestException;

$response = Http::withToken($this->getToken())->retry(2, 0, function (Exception $exception, PendingRequest $request) {
    if (! $exception instanceof RequestException || $exception->response->status() !== 401) {
        return false;
    }

    $request->withToken($this->getNewToken());

    return true;
})->post(/* ... */);

すべてのリクエストが失敗した場合、Illuminate\Http\Client\RequestExceptionのインスタンスが投げられます。この動作を無効にしたい場合は、throw引数にfalseの値を指定します。無効にすると、すべての再試行が試みられた後、クライアントが受信した最後のレスポンスが返されます。

1$response = Http::retry(3, 100, throw: false)->post(/* ... */);

$response = Http::retry(3, 100, throw: false)->post(/* ... */);

throw引数がfalseに設定されていても、接続の問題ですべてのリクエストが失敗した場合は、Illuminate\Http\Client\ConnectionExceptionが投げられます。

エラー処理

Guzzleのデフォルトの動作とは異なり、LaravelのHTTPクライアントラッパーは、クライアントエラーまたはサーバーエラー（サーバーからの400および500レベルのレスポンス）で例外を投げません。これらのエラーのいずれかが返されたかどうかを判断するには、successful、clientError、またはserverErrorメソッドを使用します。

 1// Determine if the status code is >= 200 and < 300...
 2$response->successful();
 3 
 4// Determine if the status code is >= 400...
 5$response->failed();
 6 
 7// Determine if the response has a 400 level status code...
 8$response->clientError();
 9 
10// Determine if the response has a 500 level status code...
11$response->serverError();
12 
13// Immediately execute the given callback if there was a client or server error...
14$response->onError(callable $callback);

// Determine if the status code is >= 200 and < 300...
$response->successful();

// Determine if the status code is >= 400...
$response->failed();

// Determine if the response has a 400 level status code...
$response->clientError();

// Determine if the response has a 500 level status code...
$response->serverError();

// Immediately execute the given callback if there was a client or server error...
$response->onError(callable $callback);

例外のスロー

レスポンスインスタンスがあり、レスポンスのステータスコードがクライアントエラーまたはサーバーエラーを示している場合にIlluminate\Http\Client\RequestExceptionのインスタンスを投げたい場合は、throwまたはthrowIfメソッドを使用できます。

 1use Illuminate\Http\Client\Response;
 2 
 3$response = Http::post(/* ... */);
 4 
 5// Throw an exception if a client or server error occurred...
 6$response->throw();
 7 
 8// Throw an exception if an error occurred and the given condition is true...
 9$response->throwIf($condition);
10 
11// Throw an exception if an error occurred and the given closure resolves to true...
12$response->throwIf(fn (Response $response) => true);
13 
14// Throw an exception if an error occurred and the given condition is false...
15$response->throwUnless($condition);
16 
17// Throw an exception if an error occurred and the given closure resolves to false...
18$response->throwUnless(fn (Response $response) => false);
19 
20// Throw an exception if the response has a specific status code...
21$response->throwIfStatus(403);
22 
23// Throw an exception unless the response has a specific status code...
24$response->throwUnlessStatus(200);
25 
26return $response['user']['id'];

use Illuminate\Http\Client\Response;

$response = Http::post(/* ... */);

// Throw an exception if a client or server error occurred...
$response->throw();

// Throw an exception if an error occurred and the given condition is true...
$response->throwIf($condition);

// Throw an exception if an error occurred and the given closure resolves to true...
$response->throwIf(fn (Response $response) => true);

// Throw an exception if an error occurred and the given condition is false...
$response->throwUnless($condition);

// Throw an exception if an error occurred and the given closure resolves to false...
$response->throwUnless(fn (Response $response) => false);

// Throw an exception if the response has a specific status code...
$response->throwIfStatus(403);

// Throw an exception unless the response has a specific status code...
$response->throwUnlessStatus(200);

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

Illuminate\Http\Client\RequestExceptionインスタンスは、公開の$responseプロパティを持っており、返されたレスポンスを調べることができます。

throwメソッドは、エラーが発生しなかった場合はレスポンスインスタンスを返すので、throwメソッドに他の操作をチェーンできます。

1return Http::post(/* ... */)->throw()->json();

return Http::post(/* ... */)->throw()->json();

例外が投げられる前に追加のロジックを実行したい場合は、throwメソッドにクロージャを渡してください。クロージャが呼び出された後、例外は自動的に投げられるため、クロージャ内から例外を再スローする必要はありません。

1use Illuminate\Http\Client\Response;
2use Illuminate\Http\Client\RequestException;
3 
4return Http::post(/* ... */)->throw(function (Response $response, RequestException $e) {
5    // ...
6})->json();

use Illuminate\Http\Client\Response;
use Illuminate\Http\Client\RequestException;

return Http::post(/* ... */)->throw(function (Response $response, RequestException $e) {
    // ...
})->json();

デフォルトでは、RequestExceptionメッセージはログ記録またはレポートされる際に120文字に切り詰められます。この動作をカスタマイズまたは無効にするには、アプリケーションのbootstrap/app.phpファイルで例外処理を設定する際に、truncateRequestExceptionsAtおよびdontTruncateRequestExceptionsメソッドを利用できます。

1->withExceptions(function (Exceptions $exceptions) {
2    // Truncate request exception messages to 240 characters...
3    $exceptions->truncateRequestExceptionsAt(240);
4 
5    // Disable request exception message truncation...
6    $exceptions->dontTruncateRequestExceptions();
7})

->withExceptions(function (Exceptions $exceptions) {
    // Truncate request exception messages to 240 characters...
    $exceptions->truncateRequestExceptionsAt(240);

    // Disable request exception message truncation...
    $exceptions->dontTruncateRequestExceptions();
})

Guzzleミドルウェア

LaravelのHTTPクライアントはGuzzleを利用しているため、Guzzleミドルウェアを活用して、送信リクエストを操作したり、受信レスポンスを検査したりできます。送信リクエストを操作するには、withRequestMiddlewareメソッドを介してGuzzleミドルウェアを登録します。

1use Illuminate\Support\Facades\Http;
2use Psr\Http\Message\RequestInterface;
3 
4$response = Http::withRequestMiddleware(
5    function (RequestInterface $request) {
6        return $request->withHeader('X-Example', 'Value');
7    }
8)->get('http://example.com');

use Illuminate\Support\Facades\Http;
use Psr\Http\Message\RequestInterface;

$response = Http::withRequestMiddleware(
    function (RequestInterface $request) {
        return $request->withHeader('X-Example', 'Value');
    }
)->get('http://example.com');

同様に、withResponseMiddlewareメソッドを介してミドルウェアを登録することで、受信HTTPレスポンスを検査できます。

 1use Illuminate\Support\Facades\Http;
 2use Psr\Http\Message\ResponseInterface;
 3 
 4$response = Http::withResponseMiddleware(
 5    function (ResponseInterface $response) {
 6        $header = $response->getHeader('X-Example');
 7 
 8        // ...
 9 
10        return $response;
11    }
12)->get('http://example.com');

use Illuminate\Support\Facades\Http;
use Psr\Http\Message\ResponseInterface;

$response = Http::withResponseMiddleware(
    function (ResponseInterface $response) {
        $header = $response->getHeader('X-Example');

        // ...

        return $response;
    }
)->get('http://example.com');

グローバルミドルウェア

すべての送信リクエストと受信レスポンスに適用されるミドルウェアを登録したい場合があります。これを実現するには、globalRequestMiddlewareメソッドとglobalResponseMiddlewareメソッドを使用できます。通常、これらのメソッドはアプリケーションのAppServiceProviderのbootメソッドで呼び出すべきです。

1use Illuminate\Support\Facades\Http;
2 
3Http::globalRequestMiddleware(fn ($request) => $request->withHeader(
4    'User-Agent', 'Example Application/1.0'
5));
6 
7Http::globalResponseMiddleware(fn ($response) => $response->withHeader(
8    'X-Finished-At', now()->toDateTimeString()
9));

use Illuminate\Support\Facades\Http;

Http::globalRequestMiddleware(fn ($request) => $request->withHeader(
    'User-Agent', 'Example Application/1.0'
));

Http::globalResponseMiddleware(fn ($response) => $response->withHeader(
    'X-Finished-At', now()->toDateTimeString()
));

Guzzleオプション

withOptionsメソッドを使用して、送信リクエストに追加のGuzzleリクエストオプションを指定できます。withOptionsメソッドは、キー／値のペアの配列を引数に取ります。

1$response = Http::withOptions([
2    'debug' => true,
3])->get('http://example.com/users');

$response = Http::withOptions([
    'debug' => true,
])->get('http://example.com/users');

グローバルオプション

すべての送信リクエストのデフォルトオプションを設定するには、globalOptionsメソッドを利用できます。通常、このメソッドはアプリケーションのAppServiceProviderのbootメソッドから呼び出すべきです。

 1use Illuminate\Support\Facades\Http;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(): void
 7{
 8    Http::globalOptions([
 9        'allow_redirects' => false,
10    ]);
11}

use Illuminate\Support\Facades\Http;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Http::globalOptions([
        'allow_redirects' => false,
    ]);
}

並行リクエスト

複数のHTTPリクエストを並行して行いたい場合があります。言い換えれば、リクエストを順次発行するのではなく、いくつかのリクエストを同時にディスパッチしたい場合です。これは、低速なHTTP APIとやり取りする際に、大幅なパフォーマンス向上につながる可能性があります。

幸いなことに、poolメソッドを使用すればこれを実現できます。poolメソッドは、Illuminate\Http\Client\Poolインスタンスを受け取るクロージャを引数に取り、リクエストをディスパッチ用のリクエストプールに簡単に追加できるようにします。

 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->get('https:///first'),
 6    $pool->get('https:///second'),
 7    $pool->get('https:///third'),
 8]);
 9 
10return $responses[0]->ok() &&
11       $responses[1]->ok() &&
12       $responses[2]->ok();

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$responses = Http::pool(fn (Pool $pool) => [
    $pool->get('https:///first'),
    $pool->get('https:///second'),
    $pool->get('https:///third'),
]);

return $responses[0]->ok() &&
       $responses[1]->ok() &&
       $responses[2]->ok();

ご覧のとおり、各レスポンスインスタンスはプールに追加された順序に基づいてアクセスできます。必要であれば、asメソッドを使用してリクエストに名前を付けることができ、これにより対応するレスポンスに名前でアクセスできます。

 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->as('first')->get('https:///first'),
 6    $pool->as('second')->get('https:///second'),
 7    $pool->as('third')->get('https:///third'),
 8]);
 9 
10return $responses['first']->ok();

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$responses = Http::pool(fn (Pool $pool) => [
    $pool->as('first')->get('https:///first'),
    $pool->as('second')->get('https:///second'),
    $pool->as('third')->get('https:///third'),
]);

return $responses['first']->ok();

並行リクエストのカスタマイズ

poolメソッドは、withHeadersやmiddlewareなどの他のHTTPクライアントメソッドとチェーンできません。プールされたリクエストにカスタムヘッダやミドルウェアを適用したい場合は、プール内の各リクエストでそれらのオプションを設定する必要があります。

 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$headers = [
 5    'X-Example' => 'example',
 6];
 7 
 8$responses = Http::pool(fn (Pool $pool) => [
 9    $pool->withHeaders($headers)->get('http://laravel.test/test'),
10    $pool->withHeaders($headers)->get('http://laravel.test/test'),
11    $pool->withHeaders($headers)->get('http://laravel.test/test'),
12]);

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$headers = [
    'X-Example' => 'example',
];

$responses = Http::pool(fn (Pool $pool) => [
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
]);

マクロ

Laravel HTTPクライアントでは「マクロ」を定義できます。これは、アプリケーション全体でサービスとやり取りする際に、共通のリクエストパスやヘッダを設定するための流暢で表現力豊かなメカニズムとして機能します。まず、アプリケーションのApp\Providers\AppServiceProviderクラスのbootメソッド内でマクロを定義します。

 1use Illuminate\Support\Facades\Http;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(): void
 7{
 8    Http::macro('github', function () {
 9        return Http::withHeaders([
10            'X-Example' => 'example',
11        ])->baseUrl('https://github.com');
12    });
13}

use Illuminate\Support\Facades\Http;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Http::macro('github', function () {
        return Http::withHeaders([
            'X-Example' => 'example',
        ])->baseUrl('https://github.com');
    });
}

マクロを設定したら、アプリケーションのどこからでもそれを呼び出して、指定した設定でペンディングリクエストを作成できます。

1$response = Http::github()->get('/');

$response = Http::github()->get('/');

テスト

多くのLaravelサービスは、テストを簡単かつ表現力豊かに記述するのに役立つ機能を提供しており、LaravelのHTTPクライアントも例外ではありません。Httpファサードのfakeメソッドを使用すると、リクエストが行われたときにスタブ化／ダミーのレスポンスを返すようにHTTPクライアントに指示できます。

レスポンスの偽装

例えば、すべてのリクエストに対して空の200ステータスコードのレスポンスを返すようにHTTPクライアントに指示するには、引数なしでfakeメソッドを呼び出します。

1use Illuminate\Support\Facades\Http;
2 
3Http::fake();
4 
5$response = Http::post(/* ... */);

use Illuminate\Support\Facades\Http;

Http::fake();

$response = Http::post(/* ... */);

特定のURLの偽装

あるいは、fakeメソッドに配列を渡すこともできます。配列のキーは、偽装したいURLパターンとそれに関連するレスポンスを表す必要があります。*文字はワイルドカード文字として使用できます。偽装されていないURLへのリクエストは実際に実行されます。Httpファサードのresponseメソッドを使用して、これらのエンドポイントのスタブ／偽装レスポンスを構築できます。

1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),
4 
5    // Stub a string response for Google endpoints...
6    'google.com/*' => Http::response('Hello World', 200, $headers),
7]);

Http::fake([
    // Stub a JSON response for GitHub endpoints...
    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),

    // Stub a string response for Google endpoints...
    'google.com/*' => Http::response('Hello World', 200, $headers),
]);

一致しないすべてのURLをスタブ化するフォールバックURLパターンを指定したい場合は、単一の*文字を使用します。

1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
4 
5    // Stub a string response for all other endpoints...
6    '*' => Http::response('Hello World', 200, ['Headers']),
7]);

Http::fake([
    // Stub a JSON response for GitHub endpoints...
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // Stub a string response for all other endpoints...
    '*' => Http::response('Hello World', 200, ['Headers']),
]);

便宜上、レスポンスとして文字列、配列、または整数を提供することで、単純な文字列、JSON、および空のレスポンスを生成できます。

1Http::fake([
2    'google.com/*' => 'Hello World',
3    'github.com/*' => ['foo' => 'bar'],
4    'chatgpt.com/*' => 200,
5]);

Http::fake([
    'google.com/*' => 'Hello World',
    'github.com/*' => ['foo' => 'bar'],
    'chatgpt.com/*' => 200,
]);

接続例外の偽装

リクエストを試行した際にHTTPクライアントがIlluminate\Http\Client\ConnectionExceptionに遭遇した場合のアプリケーションの動作をテストする必要がある場合があります。failedConnectionメソッドを使用して、HTTPクライアントに接続例外をスローさせることができます。

1Http::fake([
2    'github.com/*' => Http::failedConnection(),
3]);

Http::fake([
    'github.com/*' => Http::failedConnection(),
]);

レスポンスシーケンスの偽装

単一のURLが特定の順序で一連の偽のレスポンスを返すように指定する必要がある場合があります。これは、Http::sequenceメソッドを使用してレスポンスを構築することで実現できます。

1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4        ->push('Hello World', 200)
5        ->push(['foo' => 'bar'], 200)
6        ->pushStatus(404),
7]);

Http::fake([
    // Stub a series of responses for GitHub endpoints...
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->pushStatus(404),
]);

レスポンスシーケンス内のすべてのレスポンスが消費されると、それ以降のリクエストはレスポンスシーケンスに例外をスローさせます。シーケンスが空のときに返すべきデフォルトのレスポンスを指定したい場合は、whenEmptyメソッドを使用できます。

1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4        ->push('Hello World', 200)
5        ->push(['foo' => 'bar'], 200)
6        ->whenEmpty(Http::response()),
7]);

Http::fake([
    // Stub a series of responses for GitHub endpoints...
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->whenEmpty(Http::response()),
]);

レスポンスのシーケンスを偽装したいが、偽装すべき特定のURLパターンを指定する必要がない場合は、Http::fakeSequenceメソッドを使用できます。

1Http::fakeSequence()
2    ->push('Hello World', 200)
3    ->whenEmpty(Http::response());

Http::fakeSequence()
    ->push('Hello World', 200)
    ->whenEmpty(Http::response());

偽装コールバック

特定のエンドポイントに対してどのレスポンスを返すかを決定するために、より複雑なロジックが必要な場合は、fakeメソッドにクロージャを渡すことができます。このクロージャはIlluminate\Http\Client\Requestのインスタンスを受け取り、レスポンスインスタンスを返す必要があります。クロージャ内で、どのタイプのレスポンスを返すかを決定するために必要なロジックを実行できます。

1use Illuminate\Http\Client\Request;
2 
3Http::fake(function (Request $request) {
4    return Http::response('Hello World', 200);
5});

use Illuminate\Http\Client\Request;

Http::fake(function (Request $request) {
    return Http::response('Hello World', 200);
});

Strayリクエストの防止

個別のテストまたは完全なテストスイート全体で、HTTPクライアントを介して送信されたすべてのリクエストが偽装されていることを確認したい場合は、preventStrayRequestsメソッドを呼び出すことができます。このメソッドを呼び出した後、対応する偽のレスポンスがないリクエストは、実際のHTTPリクエストを行うのではなく、例外をスローします。

 1use Illuminate\Support\Facades\Http;
 2 
 3Http::preventStrayRequests();
 4 
 5Http::fake([
 6    'github.com/*' => Http::response('ok'),
 7]);
 8 
 9// An "ok" response is returned...
10Http::get('https://github.com/laravel/framework');
11 
12// An exception is thrown...
13Http::get('https://laravel.dokyumento.jp');

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

Http::fake([
    'github.com/*' => Http::response('ok'),
]);

// An "ok" response is returned...
Http::get('https://github.com/laravel/framework');

// An exception is thrown...
Http::get('https://laravel.dokyumento.jp');

リクエストの検査

レスポンスを偽装する際、アプリケーションが正しいデータやヘッダを送信していることを確認するために、クライアントが受け取るリクエストを検査したい場合があります。これは、Http::fakeを呼び出した後にHttp::assertSentメソッドを呼び出すことで実現できます。

assertSentメソッドは、Illuminate\Http\Client\Requestインスタンスを受け取るクロージャを引数に取り、リクエストが期待と一致するかどうかを示すブール値を返す必要があります。テストがパスするためには、指定された期待に一致するリクエストが少なくとも1つ発行されている必要があります。

 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::withHeaders([
 7    'X-First' => 'foo',
 8])->post('http://example.com/users', [
 9    'name' => 'Taylor',
10    'role' => 'Developer',
11]);
12 
13Http::assertSent(function (Request $request) {
14    return $request->hasHeader('X-First', 'foo') &&
15           $request->url() == 'http://example.com/users' &&
16           $request['name'] == 'Taylor' &&
17           $request['role'] == 'Developer';
18});

use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;

Http::fake();

Http::withHeaders([
    'X-First' => 'foo',
])->post('http://example.com/users', [
    'name' => 'Taylor',
    'role' => 'Developer',
]);

Http::assertSent(function (Request $request) {
    return $request->hasHeader('X-First', 'foo') &&
           $request->url() == 'http://example.com/users' &&
           $request['name'] == 'Taylor' &&
           $request['role'] == 'Developer';
});

必要であれば、assertNotSentメソッドを使用して、特定のリクエストが送信されなかったことをアサートできます。

 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::post('http://example.com/users', [
 7    'name' => 'Taylor',
 8    'role' => 'Developer',
 9]);
10 
11Http::assertNotSent(function (Request $request) {
12    return $request->url() === 'http://example.com/posts';
13});

use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;

Http::fake();

Http::post('http://example.com/users', [
    'name' => 'Taylor',
    'role' => 'Developer',
]);

Http::assertNotSent(function (Request $request) {
    return $request->url() === 'http://example.com/posts';
});

assertSentCountメソッドを使用して、テスト中にいくつのリクエストが「送信」されたかをアサートできます。

1Http::fake();
2 
3Http::assertSentCount(5);

Http::fake();

Http::assertSentCount(5);

または、assertNothingSentメソッドを使用して、テスト中にリクエストが送信されなかったことをアサートできます。

1Http::fake();
2 
3Http::assertNothingSent();

Http::fake();

Http::assertNothingSent();

リクエスト／レスポンスの記録

recordedメソッドを使用して、すべてのリクエストとそれに対応するレスポンスを収集できます。recordedメソッドは、Illuminate\Http\Client\RequestとIlluminate\Http\Client\Responseのインスタンスを含む配列のコレクションを返します。

 1Http::fake([
 2    'https://laravel.dokyumento.jp' => Http::response(status: 500),
 3    'https://nova.laravel.com/' => Http::response(),
 4]);
 5 
 6Http::get('https://laravel.dokyumento.jp');
 7Http::get('https://nova.laravel.com/');
 8 
 9$recorded = Http::recorded();
10 
11[$request, $response] = $recorded[0];

Http::fake([
    'https://laravel.dokyumento.jp' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.dokyumento.jp');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded();

[$request, $response] = $recorded[0];

さらに、recordedメソッドはクロージャを引数に取り、Illuminate\Http\Client\RequestとIlluminate\Http\Client\Responseのインスタンスを受け取ります。これを使用して、期待に基づいてリクエスト／レスポンスのペアをフィルタリングできます。

 1use Illuminate\Http\Client\Request;
 2use Illuminate\Http\Client\Response;
 3 
 4Http::fake([
 5    'https://laravel.dokyumento.jp' => Http::response(status: 500),
 6    'https://nova.laravel.com/' => Http::response(),
 7]);
 8 
 9Http::get('https://laravel.dokyumento.jp');
10Http::get('https://nova.laravel.com/');
11 
12$recorded = Http::recorded(function (Request $request, Response $response) {
13    return $request->url() !== 'https://laravel.dokyumento.jp' &&
14           $response->successful();
15});

use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;

Http::fake([
    'https://laravel.dokyumento.jp' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.dokyumento.jp');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded(function (Request $request, Response $response) {
    return $request->url() !== 'https://laravel.dokyumento.jp' &&
           $response->successful();
});

イベント

LaravelはHTTPリクエストを送信する過程で３つのイベントを発行します。RequestSendingイベントはリクエストが送信される前に発行され、ResponseReceivedイベントは特定のリクエストに対するレスポンスが受信された後に発行されます。ConnectionFailedイベントは特定のリクエストに対するレスポンスが受信されなかった場合に発行されます。

RequestSendingとConnectionFailedイベントは両方とも、Illuminate\Http\Client\Requestインスタンスを検査するために使用できる公開の$requestプロパティを含んでいます。同様に、ResponseReceivedイベントは$requestプロパティと、Illuminate\Http\Client\Responseインスタンスを検査するために使用できる$responseプロパティを含んでいます。アプリケーション内でこれらのイベントに対するイベントリスナを作成できます。

 1use Illuminate\Http\Client\Events\RequestSending;
 2 
 3class LogRequest
 4{
 5    /**
 6     * Handle the given event.
 7     */
 8    public function handle(RequestSending $event): void
 9    {
10        // $event->request ...
11    }
12}

use Illuminate\Http\Client\Events\RequestSending;

class LogRequest
{
    /**
     * Handle the given event.
     */
    public function handle(RequestSending $event): void
    {
        // $event->request ...
    }
}

序文

はじめに

アーキテクチャのコンセプト

基本

より深く知る

セキュリティ

データベース

Eloquent ORM

テスト

パッケージ

HTTPクライアント

製品

パッケージ

リソース