HTTP Client

Introduction

Laravel provides an expressive, minimal API around the Guzzle HTTP client, allowing you to quickly make outgoing HTTP requests to communicate with other web applications. Laravel’s wrapper around Guzzle is focused on its most common use cases and a wonderful developer experience.

Before getting started, you should ensure that you have installed the Guzzle package as a dependency of your application. By default, Laravel automatically includes this dependency:

  1. composer require guzzlehttp/guzzle

Making Requests

To make requests, you may use the get, post, put, patch, and delete methods. First, let’s examine how to make a basic GET request:

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

The get method returns an instance of Illuminate\Http\Client\Response, which provides a variety of methods that may be used to inspect the response:

  1. $response->body() : string;
  2. $response->json() : array|mixed;
  3. $response->status() : int;
  4. $response->ok() : bool;
  5. $response->successful() : bool;
  6. $response->failed() : bool;
  7. $response->serverError() : bool;
  8. $response->clientError() : bool;
  9. $response->header($header) : string;
  10. $response->headers() : array;

The Illuminate\Http\Client\Response object also implements the PHP ArrayAccess interface, allowing you to access JSON response data directly on the response:

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

Request Data

Of course, it is common when using POST, PUT, and PATCH to send additional data with your request. So, these methods accept an array of data as their second argument. By default, data will be sent using the application/json content type:

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

GET Request Query Parameters

When making GET requests, you may either append a query string to the URL directly or pass an array of key / value pairs as the second argument to the get method:

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

Sending Form URL Encoded Requests

If you would like to send data using the application/x-www-form-urlencoded content type, you should call the asForm method before making your request:

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

Sending A Raw Request Body

You may use the withBody method if you would like to provide a raw request body when making a request:

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

Multi-Part Requests

If you would like to send files as multi-part requests, you should call the attach method before making your request. This method accepts the name of the file and its contents. Optionally, you may provide a third argument which will be considered the file’s filename:

  1. $response = Http::attach(
  2.     'attachment', file_get_contents('photo.jpg'), 'photo.jpg'
  3. )->post('http://test.com/attachments');

Instead of passing the raw contents of a file, you may also pass a stream resource:

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

Headers

Headers may be added to requests using the withHeaders method. This withHeaders method accepts an array of key / value pairs:

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

Authentication

You may specify basic and digest authentication credentials using the withBasicAuth and withDigestAuth methods, respectively:

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

Bearer Tokens

If you would like to quickly add an Authorization bearer token header to the request, you may use the withToken method:

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

Timeout

The timeout method may be used to specify the maximum number of seconds to wait for a response:

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

If the given timeout is exceeded, an instance of Illuminate\Http\Client\ConnectionException will be thrown.

Retries

If you would like HTTP client to automatically retry the request if a client or server error occurs, you may use the retry method. The retry method accepts two arguments: the number of times the request should be attempted and the number of milliseconds that Laravel should wait in between attempts:

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

If all of the requests fail, an instance of Illuminate\Http\Client\RequestException will be thrown.

Error Handling

Unlike Guzzle’s default behavior, Laravel’s HTTP client wrapper does not throw exceptions on client or server errors (400 and 500 level responses from servers). You may determine if one of these errors was returned using the successful, clientError, or serverError methods:

  1. // Determine if the status code was >= 200 and < 300...
  2. $response->successful();
  4. // Determine if the status code was >= 400...
  5. $response->failed();
  7. // Determine if the response has a 400 level status code...
  8. $response->clientError();
  10. // Determine if the response has a 500 level status code...
  11. $response->serverError();

Throwing Exceptions

If you have a response instance and would like to throw an instance of Illuminate\Http\Client\RequestException if the response is a client or server error, you may use the throw method:

  1. $response = Http::post(...);
  3. // Throw an exception if a client or server error occurred...
  4. $response->throw();
  6. return $response['user']['id'];

The Illuminate\Http\Client\RequestException instance has a public $response property which will allow you to inspect the returned response.

The throw method returns the response instance if no error occurred, allowing you to chain other operations onto the throw method:

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

Guzzle Options

You may specify additional Guzzle request options using the withOptions method. The withOptions method accepts an array of key / value pairs:

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

Testing

Many Laravel services provide functionality to help you easily and expressively write tests, and Laravel’s HTTP wrapper is no exception. The Http facade’s fake method allows you to instruct the HTTP client to return stubbed / dummy responses when requests are made.

Faking Responses

For example, to instruct the HTTP client to return empty, 200 status code responses for every request, you may call the fake method with no arguments:

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

Faking Specific URLs

Alternatively, you may pass an array to the fake method. The array’s keys should represent URL patterns that you wish to fake and their associated responses. The * character may be used as a wildcard character. Any requests made to URLs that have not been faked will actually be executed. You may use the response method to construct stub / fake responses for these endpoints:

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

If you would like to specify a fallback URL pattern that will stub all unmatched URLs, you may use a single * character:

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

Faking Response Sequences

Sometimes you may need to specify that a single URL should return a series of fake responses in a specific order. You may accomplish this using the Http::sequence method to build the responses:

  1. Http::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. ]);

When all of the responses in a response sequence have been consumed, any further requests will cause the response sequence to throw an exception. If you would like to specify a default response that should be returned when a sequence is empty, you may use the whenEmpty method:

  1. Http::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. ]);

If you would like to fake a sequence of responses but do not need to specify a specific URL pattern that should be faked, you may use the Http::fakeSequence method:

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

Fake Callback

If you require more complicated logic to determine what responses to return for certain endpoints, you may pass a callback to the fake method. This callback will receive an instance of Illuminate\Http\Client\Request and should return a response instance:

  1. Http::fake(function ($request) {
  2.     return Http::response('Hello World', 200);
  3. });

Inspecting Requests

When faking responses, you may occasionally wish to inspect the requests the client receives in order to make sure your application is sending the correct data or headers. You may accomplish this by calling the Http::assertSent method after calling Http::fake.

The assertSent method accepts a callback which will be given an Illuminate\Http\Client\Request instance and should return a boolean value indicating if the request matches your expectations. In order for the test to pass, at least one request must have been issued matching the given expectations:

  1. Http::fake();
  3. Http::withHeaders([
  4.     'X-First' => 'foo',
  5. ])->post('http://test.com/users', [
  6.     'name' => 'Taylor',
  7.     'role' => 'Developer',
  8. ]);
  10. Http::assertSent(function ($request) {
  11.     return $request->hasHeader('X-First', 'foo') &&
  12.            $request->url() == 'http://test.com/users' &&
  13.            $request['name'] == 'Taylor' &&
  14.            $request['role'] == 'Developer';
  15. });

If needed, you may assert that a specific request was not sent using the assertNotSent method:

  1. Http::fake();
  3. Http::post('http://test.com/users', [
  4.     'name' => 'Taylor',
  5.     'role' => 'Developer',
  6. ]);
  8. Http::assertNotSent(function (Request $request) {
  9.     return $request->url() === 'http://test.com/posts';
  10. });

Or, if you would like to assert that no requests were sent, you may use the assertNothingSent method:

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