Guzzle is a PHP HTTP client that simplifies sending HTTP requests and integrates with web services. To create a Guzzle client with custom configuration, you use the GuzzleHttp\Client
class and pass an array of options to its constructor.
Here's an example of how to create a Guzzle client with some common custom configurations:
<?php
require 'vendor/autoload.php'; // Make sure to include the Composer autoload file
use GuzzleHttp\Client;
// Create a new GuzzleHttp client with custom configuration options
$client = new Client([
// Base URI is used with relative requests
'base_uri' => 'http://api.example.com',
// You can set any number of default request options.
'timeout' => 2.0, // Timeout in seconds
// Proxy settings
// 'proxy' => 'tcp://localhost:8125', // Use this proxy with every request
// Headers that you want to send with each request
'headers' => [
'User-Agent' => 'testing/1.0',
'Accept' => 'application/json',
'X-Foo' => ['Bar', 'Baz']
],
// SSL settings
// 'verify' => false, // Disable SSL verification, not recommended for production
// Debugging
// 'debug' => true, // Set to 'true' to enable debugging output
// Cookies
// 'cookies' => true, // Enable cookie handling
// Redirects
// 'allow_redirects' => false, // Disable redirects
// Other options
// 'http_errors' => false, // Set to 'false' to not throw exceptions on HTTP protocol errors
]);
// Now you can use the client to send requests...
$response = $client->request('GET', '/some/endpoint');
// Read the response body
$body = $response->getBody();
// Output the response
echo $body;
In this example, we set a base URI that is prepended to all relative URIs in requests. We also set a timeout, custom headers, and other options that might be relevant for different scenarios, such as proxy settings, SSL verification, debugging, cookie handling, and handling of redirects and HTTP protocol errors. Some options are commented out to show that you can easily enable or disable them as needed.
Remember to install Guzzle via Composer if you haven't already:
composer require guzzlehttp/guzzle
This command will add Guzzle to your composer.json
file and install it in the vendor
directory.
Note: It is important to handle configuration options properly based on the environment (development, staging, production, etc.) and use cases. For example, disabling SSL verification ('verify' => false
) should not be done in a production environment as it makes the HTTP client vulnerable to man-in-the-middle attacks. Similarly, enabling debugging ('debug' => true
) should typically only be done during development.