Laravel 7 has a new HTTP client that provides a minimal API around the popular Guzzle HTTP client. If you missed the news, let’s walk through some of the basics. You can find everything you need to know in the Laravel 7 HTTP Client Documentation, but lets look at some of those features at a glance.
Guzzle is a powerful HTTP client, but the 80% use-case feels complicated when trying to make a simple HTTP GET or getting data back from a JSON API.
At a glance, here are my favorite features the Laravel Http client provides:
- Chain-able Request setup
- Easy access to JSON response data
- No boilerplate setup to make a simple request
- Retrying failed requests
- Convenience methods around authentication headers (basic, digest, bearer)
- Test fakes and test inspections
For more complicated HTTP client work, you may have to use Guzzle directly, but I suspect that Laravel HTTP has everything that you’d need for most of your projects.
Here’s the most basic usage you can expect using Laravel’s HTTP client:
1use Illuminate\Support\Facades\Http;23$response = Http::get('https://laravel.com');45// Get the response body6$response->body();78$response = Http::get( 'https://api.github.com/users/paulredmond/gists' );910// Array of data from the JSON response11$data = $response->json();
There are a few ways you can access data from JSON responses: the
json() method and
1// Access the response data via `json()`2$data = $response->json();3$data['username'];45// Array access from the Response object6Http::get( 'https://api.github.com/users/paulredmond/gists' )['username'];78// Return the response object and access directly9$response = Http::get('...');10$response['username'];
One thing that can get confusing and complicated with Guzzle is continually having to wrap calls in a try/catch block, or creating a mini-abstraction on every project to handle this for you.
500 level responses and provides methods you can use to determine if anything bad happened during the response:
1$response = Http::get( 'https://api.github.com/users/paulredmond/gists' );23// Boolean checks on the response4$response->ok() : bool;5$response->clientError(): bool;6$response->successful() : bool;7$response->serverError() : bool;8$response->clientError() : bool;
After reading that Laravel handles client and server exceptions, it wasn’t obvious to me at first that timeouts will cause an exception. The default timeout is rather long; however, Laravel HTTP allows you to define it yourself (in seconds) with the convenient
1$response = Http::timeout(5)2 ->get( 'https://ffdsafdsafdsafas.com' );34// Illuminate\Http\Client\ConnectionException:5// cURL error 28: Connection timed out after 5005 milliseconds
You can learn most everything you need to know from the Laravel 7 HTTP Client Documentation. I’d also encourage you to check out the classes in Illuminate/Http—its quite a simple, elegant API which feels intuitive to use.