{"id":25348,"date":"2021-06-04T11:31:00","date_gmt":"2021-06-04T08:31:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=25348"},"modified":"2021-10-18T02:09:08","modified_gmt":"2021-10-17T23:09:08","slug":"comment-utiliser-guzzle-un-client-http-php-pour-envoyer-des-requetes-http","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/fr\/comment-utiliser-guzzle-un-client-http-php-pour-envoyer-des-requetes-http\/","title":{"rendered":"Comment utiliser Guzzle – Un client HTTP PHP pour envoyer des requ\u00eates HTTP"},"content":{"rendered":"

Le d\u00e9veloppeur rencontre toujours une t\u00e2che pour laquelle il doit envoyer des requ\u00eates HTTP \u00e0 d’autres ressources et g\u00e9rer la r\u00e9ponse. La fa\u00e7on la plus courante d’effectuer ces t\u00e2ches consiste \u00e0 utiliser un cURL. Cependant, utiliser le cURL n’est pas relativement facile pour un d\u00e9butant. Aussi pour \u00e9crire un script en cURL, votre serveur doit avoir activ\u00e9 l’extension cURL.<\/p>\n

Guzzle<\/a> est une alternative \u00e0 cURL. C’est un client PHP HTTP qui facilite l’envoi de requ\u00eates HTTP et l’int\u00e9gration aux services Web. M\u00eame, d’apr\u00e8s mon exp\u00e9rience, je peux dire que Guzzle est meilleur que cURL. C’est simple et facile \u00e0 utiliser. Si vous utilisez Guzzle, vous n’avez pas besoin d’avoir l’extension cURL sur votre serveur. Il vous donne un meilleur formatage du code par rapport \u00e0 cURL.<\/p>\n

Cela \u00e9tant dit, voyons comment utiliser Guzzle dans votre application.<\/p>\n

Installation<\/h3>\n

La m\u00e9thode recommand\u00e9e pour installer Guzzle consiste \u00e0 utiliser Composer. Si vous n’avez pas install\u00e9 Composer sur votre syst\u00e8me, vous pouvez l’obtenir ici<\/a>.<\/p>\n

\"Comment<\/a><\/p>\n

Ouvrez le terminal dans le r\u00e9pertoire racine de votre projet et ex\u00e9cutez la commande ci-dessous pour installer Guzzle.<\/p>\n

composer require guzzlehttp\/guzzle<\/code><\/pre>\n
Guzzle prend en charge toutes les requ\u00eates HTTP qui sont GET, DELETE, HEAD, OPTIONS, PATCH, POST et PUT. Dans ce tutoriel, nous \u00e9tudions comment utiliser Guzzle pour envoyer des requ\u00eates HTTP et g\u00e9rer les r\u00e9ponses avec.<\/p>\n
\u00c0 titre d’exemple, je prends le service REQ|RES<\/a> qui fournit une fausse vraie API pour tester les requ\u00eates HTTP.<\/p>\n
Comment envoyer une requ\u00eate HTTP \u00e0 l’aide de Guzzle<\/h3>\n
Lors de l’installation de la biblioth\u00e8que Guzzle, vous devez inclure un environnement Guzzle dans votre fichier comme suit.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\nuse GuzzleHttpClient;<\/code><\/pre>\n
Essayons maintenant quelques op\u00e9rations une par une telles que GET, POST, T\u00e9l\u00e9chargement de fichier, copie de fichier d’une URL distante vers un r\u00e9pertoire local, PUT, PATCH et DELETE.<\/p>\n
GET Requ\u00eate en utilisant Guzzle<\/h4>\n
Si vous regardez le site Web de REQ|RES, ils ont fourni quelques points de terminaison pour les demandes \u00ab\u00a0GET\u00a0\u00bb. Je vais prendre l’exemple du point de terminaison ‘LIST USERS’. Pour obtenir la liste des utilisateurs, ils demandent d’envoyer une requ\u00eate GET \u00e0 ce point de terminaison https:\/\/reqres.in\/api\/users?page=2<\/a>.<\/p>\n
Dans Guzzle, nous enverrons cette requ\u00eate GET comme suit.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'https:\/\/reqres.in',\n]);\n\u00a0\u00a0\n$response = $client->request('GET', '\/api\/users', [\n\u00a0\u00a0\u00a0\u00a0'query' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'page' => '2',\n\u00a0\u00a0\u00a0\u00a0]\n]);\n\u00a0\n\/\/get status code using $response->getStatusCode();\n\u00a0\n$body = $response->getBody();\n$arr_body = json_decode($body);\nprint_r($arr_body);<\/code><\/pre>\n
J’ai d’abord extrait une ‘base_uri’ (URL commune) en tant que https:\/\/reqres.in<\/a>. Ici, le point de terminaison final est ‘\/api\/users’ et il n\u00e9cessite un param\u00e8tre GET comme ‘page’. Dans Guzzle, vous pouvez envoyer des param\u00e8tres GET en utilisant le tableau ‘query’ comme indiqu\u00e9 dans le code ci-dessus.<\/p>\n
Demande POST \u00e0 \u200b\u200bl’aide de Guzzle<\/h4>\n
Normalement, il existe 2 types de requ\u00eates POST. Vous devrez peut-\u00eatre envoyer les param\u00e8tres en tant que demande POST ‘application\/x-www-form-urlencoded’ ou t\u00e9l\u00e9charger des donn\u00e9es encod\u00e9es JSON en tant que corps de la demande. Vous pouvez publier des donn\u00e9es encod\u00e9es JSON comme indiqu\u00e9 ci-dessous.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'https:\/\/reqres.in',\n]);\n\u00a0\n$response = $client->request('POST', '\/api\/users', [\n\u00a0\u00a0\u00a0\u00a0'json' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'name' => 'Sam',\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'job' => 'Developer'\n\u00a0\u00a0\u00a0\u00a0]\n]);\n\u00a0\n\/\/get status code using $response->getStatusCode();\n\u00a0\n$body = $response->getBody();\n$arr_body = json_decode($body);\nprint_r($arr_body);<\/code><\/pre>\n
Dans le cas de la requ\u00eate POST ‘application\/x-www-form-urlencoded’, vous pouvez POST les param\u00e8tres comme suit.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'BASE_URL_ENDPOINT',\n]);\n\u00a0\n$client->request('POST', '\/endpoint_here', [\n\u00a0\u00a0\u00a0'form_params' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'foo' => 'bar',\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'baz' => ['hi', 'there!']\n\u00a0\u00a0\u00a0]\n]);<\/code><\/pre>\n
Dans certains cas, les points de terminaison d’API vous demandent d’envoyer un jeton d’autorisation dans chaque requ\u00eate HTTP. L’utilisateur peut envoyer ce jeton sous forme d’en-t\u00eates dans votre demande Guzzle.<\/p>\n
<?php\n$client->request('POST', '\/endpoint_here', [\n\u00a0\u00a0\u00a0\u00a0\"headers\" => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"Authorization\" => \"Bearer TOKEN_VALUE\"\n\u00a0\u00a0\u00a0\u00a0],\n\u00a0\u00a0\u00a0\u00a0'form_params' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'foo' => 'bar',\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'baz' => ['hi', 'there!']\n\u00a0\u00a0\u00a0\u00a0]\n]);<\/code><\/pre>\n
Copier le fichier du serveur distant \u00e0 l’aide de Guzzle<\/h4>\n
Si vous cherchez \u00e0 copier un fichier d’un serveur distant vers votre r\u00e9pertoire local, Guzzle sera une meilleure option. Supposons que vous souhaitiez copier cette image \u00e0 l’ adresse https:\/\/artisansweb.net\/wp-content\/uploads\/2020\/03\/blog.jpg en<\/a> tant que \u00ab\u00a0blog.jpg\u00a0\u00bb dans votre r\u00e9pertoire local. Nous allons \u00e9crire le code pour cela comme indiqu\u00e9 ci-dessous.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\n$fp = fopen('blog.jpg', 'wb');\n\u00a0\n$client = new GuzzleHttpClient();\n$request = $client->get('https:\/\/artisansweb.net\/wp-content\/uploads\/2020\/03\/blog.jpg', ['sink' => $fp]);\n\u00a0\nfclose($fp);<\/code><\/pre>\n
T\u00e9l\u00e9chargement de fichiers avec Guzzle<\/h4>\n
Comme nous le savons tous, pour t\u00e9l\u00e9charger des fichiers, nous devons d\u00e9finir le corps de la demande sur un formulaire \u00ab\u00a0multipart\/form-data\u00a0\u00bb. Le code de base dans Guzzle pour le t\u00e9l\u00e9chargement de fichiers serait \u00e9crit comme ci-dessous.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'BASE_URL_HERE',\n]);\n\u00a0\n$client->request('POST', '\/endpoint_here', [\n\u00a0\u00a0\u00a0\u00a0'multipart' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0[\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'name'\u00a0\u00a0\u00a0\u00a0 => 'files', \/\/ name value requires by endpoint\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'contents' => fopen('\/path\/to\/file', 'r'),\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'filename' => 'custom_image.jpg'\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0],\n\u00a0\u00a0\u00a0\u00a0]\n]);<\/code><\/pre>\n
Pour d\u00e9montrer le t\u00e9l\u00e9chargement de fichier, je vais prendre un exemple en direct de l’ API reSmush.it<\/a> qui envoie une version optimis\u00e9e de l’image en r\u00e9ponse. Vous devez POSTER votre image \u00e0 leur point de terminaison. Le code pour cela en utilisant Guzzle comme suit.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\ntry {\n\u00a0\u00a0\u00a0\u00a0$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'base_uri' => 'http:\/\/api.resmush.it',\n\u00a0\u00a0\u00a0\u00a0]);\n\u00a0\n\u00a0\u00a0\u00a0\u00a0$response = $client->request('POST', \"?qlty=92\", [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'multipart' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0[\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'name'\u00a0\u00a0\u00a0\u00a0 => 'files', \/\/ name value requires by endpoint\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'contents' => fopen(getcwd().'\/blog.jpg', 'r'),\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'filename' => 'blog.jpg',\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'headers'\u00a0 => array('Content-Type' => mime_content_type(getcwd().'\/blog.jpg'))\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]\n\u00a0\u00a0\u00a0\u00a0]);\n\u00a0\n\u00a0\u00a0\u00a0\u00a0if (200 == $response->getStatusCode()) {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$response = $response->getBody();\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$arr_result = json_decode($response);\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0print_r($arr_result);\n\u00a0\u00a0\u00a0\u00a0}\n} catch (Exception $e) {\n\u00a0\u00a0\u00a0\u00a0echo $e->getMessage();\n}<\/code><\/pre>\n
Requ\u00eate PUT, PATCH et DELETE avec Guzzle<\/h3>\n
Les requ\u00eates PUT et PATCH sont utilis\u00e9es pour mettre \u00e0 jour les ressources. Cependant, ces 2 requ\u00eates le font diff\u00e9remment.<\/p>\n
PUT \u00e9crase toute l’entit\u00e9 si elle existe d\u00e9j\u00e0 et cr\u00e9e une nouvelle ressource si elle n’existe pas. Si vous souhaitez mettre \u00e0 jour le nom d’une personne, vous devez envoyer l’int\u00e9gralit\u00e9 de la ressource lors d’une requ\u00eate PUT.<\/p>\n
<?php\n<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'https:\/\/reqres.in',\n]);\n\u00a0\u00a0\n$response = $client->request('PUT', '\/api\/users\/2', [\n\u00a0\u00a0\u00a0\u00a0'json' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'name' => 'Sam',\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'job' => 'Developer'\n\u00a0\u00a0\u00a0\u00a0]\n]);\n\u00a0\u00a0\n\/\/get status code using $response->getStatusCode();\n\u00a0\n$body = $response->getBody();\n$arr_body = json_decode($body);\nprint_r($arr_body);<\/code><\/pre>\n
La demande PATCH applique une mise \u00e0 jour partielle \u00e0 la ressource. Cela signifie que vous n’\u00eates tenu d’envoyer que les donn\u00e9es que vous souhaitez mettre \u00e0 jour, et cela n’affectera ni ne changera rien d’autre. Ainsi, si vous souhaitez mettre \u00e0 jour le nom d’une personne, il vous suffira d’envoyer le param\u00e8tre name.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'https:\/\/reqres.in',\n]);\n\u00a0\u00a0\n$response = $client->request('PATCH', '\/api\/users\/2', [\n\u00a0\u00a0\u00a0\u00a0'json' => [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'name' => 'Sam',\n\u00a0\u00a0\u00a0\u00a0]\n]);\n\u00a0\u00a0\n\/\/get status code using $response->getStatusCode();\n\u00a0\n$body = $response->getBody();\n$arr_body = json_decode($body);\nprint_r($arr_body);<\/code><\/pre>\n
Une demande DELETE est simple. Il vous suffit d’atteindre le point de terminaison comme suit.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\u00a0\nuse GuzzleHttpClient;\n\u00a0\u00a0\n$client = new Client([\n\u00a0\u00a0\u00a0\u00a0\/\/ Base URI is used with relative requests\n\u00a0\u00a0\u00a0\u00a0'base_uri' => 'https:\/\/reqres.in',\n]);\n\u00a0\u00a0\n$response = $client->request('DELETE', '\/api\/users\/2');\n\u00a0\u00a0\necho $response->getStatusCode(); \/\/should gives 204<\/code><\/pre>\n
J’esp\u00e8re que vous avez d\u00e9couvert Guzzle et les bases de son utilisation. Vous pouvez en savoir plus sur les options de demande de Guzzle dans leur documentation<\/a>. S’il vous pla\u00eet partager vos pens\u00e9es ou suggestions dans la section commentaires ci-dessous.<\/p>\n
Articles Li\u00e9s<\/h4>\n