さらに深く掘り下げる - HTTP クライアント（HTTP Client） - 《Laravel 11.x ドキュメント》日本語

はじめに
リクエストの作成
- URIテンプレート
- リクエストのダンプ
リクエストデータ
ヘッダー
認証
- ベアラートークン
タイムアウト
リトライ
エラーハンドリング
- 例外のスロー
Guzzleミドルウェア
- グローバルミドルウェア
Guzzleオプション
- グローバルオプション
同時リクエスト
- 同時リクエストのカスタマイズ
マクロ
テスト
イベント

はじめに

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

リクエストの作成

リクエストを作成するには、head、get、post、put、patch、およびdeleteメソッドをHttpファサードから使用できます。まず、他のURLに基本的なGETリクエストを作成する方法を見てみましょう:

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


``````php
$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;
`


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

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

$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メソッドを使用します:

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

リクエストのダンプ

送信される前にアウトゴーイングリクエストインスタンスをダンプし、スクリプトの実行を終了したい場合は、リクエスト定義の最初にddメソッドを追加できます:

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

リクエストデータ

もちろん、POST、PUT、およびPATCHリクエストを作成する際に追加データを送信することは一般的であるため、これらのメソッドは第二引数としてデータの配列を受け入れます。デフォルトでは、データはapplication/jsonコンテンツタイプを使用して送信されます:

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

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


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

また、withQueryParametersメソッドを使用することもできます:

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

フォームURLエンコードリクエストの送信


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

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

リクエストを作成する際に生のリクエストボディを提供したい場合は、withBodyメソッドを使用できます。コンテンツタイプはメソッドの第二引数を介して提供できます:

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

マルチパートリクエスト

ファイルをマルチパートリクエストとして送信したい場合は、リクエストを作成する前にattachメソッドを呼び出す必要があります。このメソッドは、ファイルの名前とその内容を受け入れます。必要に応じて、ファイル名と見なされる第三引数を提供することができ、第四引数を使用してファイルに関連するヘッダーを提供することができます:

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

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

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

ヘッダー

ヘッダーは、withHeadersメソッドを使用してリクエストに追加できます。このwithHeadersメソッドは、キー/バリューペアの配列を受け入れます:

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


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

便利なことに、acceptJsonメソッドを使用して、アプリケーションがリクエストに対するレスポンスでapplication/jsonコンテンツタイプを期待していることを迅速に指定できます:

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


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

認証

基本認証およびダイジェスト認証の資格情報をそれぞれwithBasicAuthおよびwithDigestAuthメソッドを使用して指定できます:

// Basic authentication...
$response = Http::withBasicAuth('', 'secret')->post(/* ... */);
// Digest authentication...
$response = Http::withDigestAuth('', 'secret')->post(/* ... */);

ベアラートークン

リクエストのAuthorizationヘッダーにベアラートークンを迅速に追加したい場合は、withTokenメソッドを使用できます:

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

タイムアウト


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

指定されたタイムアウトが超過された場合、Illuminate\Http\Client\ConnectionExceptionのインスタンスがスローされます。

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

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

リトライ

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

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

試行の間にスリープするミリ秒数を手動で計算したい場合は、retryメソッドの第二引数としてクロージャを渡すことができます:

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

便利なことに、retryメソッドの第一引数として配列を提供することもできます。この配列は、後続の試行の間にスリープするミリ秒数を決定するために使用されます:

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

必要に応じて、retryメソッドに第三引数を渡すことができます。第三引数は、リトライが実際に試行されるべきかどうかを決定するコール可能である必要があります。たとえば、最初のリクエストがConnectionExceptionに遭遇した場合にのみリクエストを再試行したい場合があります:

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

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

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の値を提供できます。無効にすると、すべてのリトライが試行された後、クライアントによって受信された最後のレスポンスが返されます:

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

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

エラーハンドリング

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

// 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メソッドを使用できます:

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'];


`````throw`````メソッドは、エラーが発生しなかった場合にレスポンスインスタンスを返し、`````throw`````メソッドに他の操作をチェーンすることを可能にします:  
``````php
return Http::post(/* ... */)->throw()->json();
`

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

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

Guzzleミドルウェア

LaravelのHTTPクライアントはGuzzleによって動かされているため、Guzzleミドルウェアを利用してアウトゴーイングリクエストを操作したり、インカミングレスポンスを検査したりできます。アウトゴーイングリクエストを操作するには、withRequestMiddlewareメソッドを介してGuzzleミドルウェアを登録します:

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レスポンスを検査できます:

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メソッド内で呼び出されるべきです:

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オプション

アウトゴーイングリクエストに対して追加のGuzzleリクエストオプションを指定するには、withOptionsメソッドを使用します。withOptionsメソッドは、キー/バリューペアの配列を受け入れます:

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

グローバルオプション

すべてのアウトゴーイングリクエストのデフォルトオプションを構成するには、globalOptionsメソッドを利用できます。通常、このメソッドはアプリケーションのAppServiceProviderのbootメソッドから呼び出されるべきです:

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インスタンスを受け取るクロージャを受け入れ、リクエストプールにリクエストを簡単に追加できます:

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;
$responses = Http::pool(fn (Pool $pool) => [
   $pool->get('http://localhost/first'),
   $pool->get('http://localhost/second'),
   $pool->get('http://localhost/third'),
]);
return $responses[0]->ok() &&
   $responses[1]->ok() &&
   $responses[2]->ok();

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

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;
$responses = Http::pool(fn (Pool $pool) => [
   $pool->as('first')->get('http://localhost/first'),
   $pool->as('second')->get('http://localhost/second'),
   $pool->as('third')->get('http://localhost/third'),
]);
return $responses['first']->ok();

同時リクエストのカスタマイズ


``````php
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メソッド内でマクロを定義できます:

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');
   });
}

マクロが構成されると、アプリケーションのどこからでもそれを呼び出して、指定された構成で保留中のリクエストを作成できます:

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

テスト

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

レスポンスのフェイク

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

use Illuminate\Support\Facades\Http;
Http::fake();
$response = Http::post(/* ... */);

特定のURLのフェイク

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

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パターンを指定したい場合は、単一の*文字を使用できます:

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']),
]);

レスポンスシーケンスのフェイク

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

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メソッドを使用できます:

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メソッドを使用できます:

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

フェイクコールバック

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

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

迷惑なリクエストの防止

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

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.com');

リクエストの検査

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


``````php
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メソッドを使用して特定のリクエストが送信されなかったことを主張できます:

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';
});


``````php
Http::fake();
Http::assertSentCount(5);
`

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

Http::fake();
Http::assertNothingSent();

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


``````php
Http::fake([
   'https://laravel.com' => Http::response(status: 500),
   'https://nova.laravel.com/' => Http::response(),
]);
Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');
$recorded = Http::recorded();
[$request, $response] = $recorded[0];
`

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

use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;
Http::fake([
   'https://laravel.com' => Http::response(status: 500),
   'https://nova.laravel.com/' => Http::response(),
]);
Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');
$recorded = Http::recorded(function (Request $request, Response $response) {
   return $request->url() !== 'https://laravel.com' &&
   $response->successful();
});

イベント

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

RequestSendingおよびConnectionFailedイベントには、$requestプロパティが公開されており、Illuminate\Http\Client\Requestインスタンスを検査するために使用できます。同様に、ResponseReceivedイベントには$requestプロパティと$responseプロパティが含まれており、Illuminate\Http\Client\Responseインスタンスを検査するために使用できます。これらのイベントのevent listenersをアプリケーション内で作成できます:

use Illuminate\Http\Client\Events\RequestSending;
class LogRequest
{
   /**
     * Handle the given event.
   */
   public function handle(RequestSending $event): void
   {
   // $event->request ...
   }
}