ほかのサービスの API を呼ぶ（HTTP クライアント）

use Illuminate\Support\Facades\Http;

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

$response->body() : string;
$response->json($key = null, $default = null, $flags = 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;

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 Server Error

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

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

use Illuminate\Support\Facades\Http;

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

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

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

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

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

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

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

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

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

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

// ベーシック認証
$response = Http::withBasicAuth('taylor@laravel.com', 'secret')->post(/* ... */);

// ダイジェスト認証
$response = Http::withDigestAuth('taylor@laravel.com', 'secret')->post(/* ... */);

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

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

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

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

use Exception;

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

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

use Illuminate\Http\Client\PendingRequest;
use Throwable;

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

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

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

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

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

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

// ステータスコードが 200 以上 300 未満か
$response->successful();

// ステータスコードが 400 以上か
$response->failed();

// ステータスコードが 400 番台か
$response->clientError();

// ステータスコードが 500 番台か
$response->serverError();

// クライアント側かサーバー側のエラーのとき、渡した処理をすぐに動かす
$response->onError(callable $callback);

use Illuminate\Http\Client\Response;

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

// クライアント側かサーバー側のエラーのとき、例外を出す
$response->throw();

// エラーで、かつ渡した条件が真のとき、例外を出す
$response->throwIf($condition);

// エラーで、かつ渡したクロージャが真を返すとき、例外を出す
$response->throwIf(fn (Response $response) => true);

// エラーで、かつ渡した条件が偽のとき、例外を出す
$response->throwUnless($condition);

// エラーで、かつ渡したクロージャが偽を返すとき、例外を出す
$response->throwUnless(fn (Response $response) => false);

// 決めたステータスコードのとき、例外を出す
$response->throwIfStatus(403);

// 決めたステータスコードでないとき、例外を出す
$response->throwUnlessStatus(200);

// サーバー側のエラー（500 以上）のとき、例外を出す
$response->throwIfServerError();

// クライアント側のエラー（400 以上 500 未満）のとき、例外を出す
$response->throwIfClientError();

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

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

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

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

use Illuminate\Http\Client\RequestException;

->registered(function (): void {
    // リクエストの例外のメッセージを 240 文字で切る
    RequestException::truncateAt(240);

    // リクエストの例外のメッセージを切らない
    RequestException::dontTruncate();
})

return Http::truncateExceptionsAt(240)->post(/* ... */);

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

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

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()
));

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

use Illuminate\Support\Facades\Http;

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

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();

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();

$responses = Http::pool(fn (Pool $pool) => [
    // ...
], concurrency: 5);

foreach ($responses as $response) {
    if ($response instanceof Throwable) {
        // つなぐのに失敗した...
    } elseif ($response->failed()) {
        // つながったが、エラーのレスポンスを受け取った...
    }
}

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

use Illuminate\Http\Client\Batch;
use Illuminate\Http\Client\ConnectionException;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Http;

$responses = Http::batch(fn (Batch $batch) => [
    $batch->get('http://localhost/first'),
    $batch->get('http://localhost/second'),
    $batch->get('http://localhost/third'),
])->before(function (Batch $batch) {
    // バッチは作られたが、まだリクエストは始まっていない...
})->progress(function (Batch $batch, int|string $key, Response $response) {
    // 1つのリクエストが、成功して終わった...
})->then(function (Batch $batch, array $results) {
    // すべてのリクエストが、成功して終わった...
})->catch(function (Batch $batch, int|string $key, Response|RequestException|ConnectionException $response) {
    // バッチのリクエストの失敗が見つかった...
})->finally(function (Batch $batch, array $results) {
    // バッチが終わった...
})->send();

$responses = Http::batch(fn (Batch $batch) => [
    $batch->as('first')->get('http://localhost/first'),
    $batch->as('second')->get('http://localhost/second'),
    $batch->as('third')->get('http://localhost/third'),
])->send();

$responses = Http::batch(fn (Batch $batch) => [
    // ...
])->concurrency(5)->send();

// バッチに割り当てられたリクエストの数
$batch->totalRequests;

// まだ処理されていないリクエストの数
$batch->pendingRequests;

// 失敗したリクエストの数
$batch->failedRequests;

// ここまでに処理されたリクエストの数
$batch->processedRequests();

// バッチが終わったか
$batch->finished();

// バッチに、失敗したリクエストがあるか
$batch->hasFailures();

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

$responses = Http::batch(fn (Batch $batch) => [
    $batch->get('http://localhost/first'),
    $batch->get('http://localhost/second'),
    $batch->get('http://localhost/third'),
])->then(function (Batch $batch, array $results) {
    // すべてのリクエストが、成功して終わった...
})->defer();

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('/');

use Illuminate\Support\Facades\Http;

Http::fake();

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

Http::fake([
    // GitHub の宛先に、JSON のレスポンスを返す
    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),

    // Google の宛先に、文字列のレスポンスを返す
    'google.com/*' => Http::response('Hello World', 200, $headers),
]);

Http::fake([
    // GitHub の宛先に、JSON のレスポンスを返す
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // それ以外のすべての宛先に、文字列のレスポンスを返す
    '*' => Http::response('Hello World', 200, ['Headers']),
]);

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

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

$this->mock(GithubService::class)
    ->shouldReceive('getUser')
    ->andThrow(
        Http::failedRequest(['code' => 'not_found'], 404)
    );

Http::fake([
    // GitHub の宛先に、決めた順番でレスポンスを返す
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->pushStatus(404),
]);

Http::fake([
    // GitHub の宛先に、決めた順番でレスポンスを返す
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->whenEmpty(Http::response()),
]);

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

use Illuminate\Http\Client\Request;

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

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

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

Http::fake();

Http::assertSentCount(5);

Http::fake();

Http::assertNothingSent();

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

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

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

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

// "ok" のレスポンスが返る
Http::get('https://github.com/laravel/framework');

// 例外が出る
Http::get('https://laravel.com');

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

Http::allowStrayRequests([
    'http://127.0.0.1:5000/*',
]);

// このリクエストは動く
Http::get('http://127.0.0.1:5000/generate');

// 例外が出る
Http::get('https://laravel.com');

use Illuminate\Http\Client\Events\RequestSending;

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