{"id":28221,"date":"2021-06-04T12:11:00","date_gmt":"2021-06-04T09:11:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=28221"},"modified":"2021-10-18T04:04:43","modified_gmt":"2021-10-18T01:04:43","slug":"como-usar-o-guzzle-um-cliente-php-http-para-enviar-solicitacoes-http","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/pt-pt\/como-usar-o-guzzle-um-cliente-php-http-para-enviar-solicitacoes-http\/","title":{"rendered":"Como usar o Guzzle – um cliente PHP HTTP para enviar solicita\u00e7\u00f5es HTTP"},"content":{"rendered":"

O desenvolvedor sempre se depara com uma tarefa em que precisa enviar solicita\u00e7\u00f5es HTTP para outros recursos e lidar com a resposta. A maneira mais comum de realizar essas tarefas \u00e9 usando um cURL. No entanto, usar o cURL n\u00e3o \u00e9 relativamente f\u00e1cil para um iniciante. Al\u00e9m disso, para escrever um script em cURL, seu servidor deve ter habilitado a extens\u00e3o cURL.<\/p>\n

Guzzle<\/a> \u00e9 uma alternativa ao cURL. \u00c9 um cliente PHP HTTP que facilita o envio de solicita\u00e7\u00f5es HTTP e facilita a integra\u00e7\u00e3o com servi\u00e7os da web. Mesmo, posso dizer por experi\u00eancia pr\u00f3pria, Guzzle \u00e9 melhor do que cURL. \u00c9 simples e f\u00e1cil de usar. Se voc\u00ea estiver usando o Guzzle, n\u00e3o precisa ter a extens\u00e3o cURL em seu servidor. Oferece uma melhor formata\u00e7\u00e3o de c\u00f3digo em compara\u00e7\u00e3o com cURL.<\/p>\n

Dito isso, vamos ver como usar o Guzzle em seu aplicativo.<\/p>\n

Instala\u00e7\u00e3o<\/h3>\n

A maneira recomendada de instalar o Guzzle \u00e9 por meio do Composer. Se voc\u00ea n\u00e3o instalou o Composer em seu sistema, pode obt\u00ea-lo aqui<\/a>.<\/p>\n

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

Abra o terminal no diret\u00f3rio raiz do seu projeto e execute o comando abaixo para instalar o Guzzle.<\/p>\n

composer require guzzlehttp\/guzzle<\/code><\/pre>\n
O Guzzle fornece suporte para todas as solicita\u00e7\u00f5es HTTP que s\u00e3o GET, DELETE, HEAD, OPTIONS, PATCH, POST e PUT. Neste tutorial, estudamos como usar o Guzzle para enviar solicita\u00e7\u00f5es HTTP e lidar com as respostas com ele.<\/p>\n
Como exemplo, tomo o servi\u00e7o REQ | RES<\/a>, que fornece uma API real falsa para testar solicita\u00e7\u00f5es HTTP.<\/p>\n
Como enviar uma solicita\u00e7\u00e3o HTTP usando o Guzzle<\/h3>\n
Ap\u00f3s a instala\u00e7\u00e3o da biblioteca Guzzle, voc\u00ea precisa incluir um ambiente Guzzle em seu arquivo da seguinte maneira.<\/p>\n
<?php\nrequire_once \"vendor\/autoload.php\";\n\u00a0\nuse GuzzleHttpClient;<\/code><\/pre>\n
Agora vamos tentar algumas opera\u00e7\u00f5es, uma a uma, como GET, POST, upload de arquivo, copiar arquivo de URL remota para um diret\u00f3rio local, PUT, PATCH e DELETE.<\/p>\n
Solicita\u00e7\u00e3o GET usando Guzzle<\/h4>\n
Se voc\u00ea olhar o site REQ | RES, eles forneceram alguns endpoints para solicita\u00e7\u00f5es ‘GET’. Vou pegar o exemplo de ponto de extremidade ‘LISTAR USU\u00c1RIOS’. Para obter a lista de usu\u00e1rios, eles pedem para enviar uma solicita\u00e7\u00e3o GET para este endpoint https:\/\/reqres.in\/api\/users?page=2<\/a>.<\/p>\n
No Guzzle, enviaremos este pedido GET da seguinte forma.<\/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
Primeiro extra\u00ed um ‘base_uri’ (URL comum) como https:\/\/reqres.in<\/a>. Aqui, o endpoint final \u00e9 ‘\/ api \/ users’ e requer um par\u00e2metro GET como ‘page’. No Guzzle, voc\u00ea pode enviar par\u00e2metros GET usando o array ‘query’ conforme mostrado no c\u00f3digo acima.<\/p>\n
Solicita\u00e7\u00e3o POST usando Guzzle<\/h4>\n
Normalmente, existem 2 tipos de solicita\u00e7\u00f5es POST. Pode ser necess\u00e1rio POSTar par\u00e2metros como solicita\u00e7\u00e3o POST ‘application \/ x-www-form-urlencoded’ ou fazer upload de dados codificados em JSON como um corpo da solicita\u00e7\u00e3o. Voc\u00ea pode postar dados codificados em JSON conforme mostrado abaixo.<\/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
No caso da solicita\u00e7\u00e3o POST ‘application \/ x-www-form-urlencoded’, voc\u00ea pode POSTar os par\u00e2metros da seguinte maneira.<\/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
Em alguns casos, os endpoints da API pedem que voc\u00ea envie um token de autoriza\u00e7\u00e3o em cada solicita\u00e7\u00e3o HTTP. O usu\u00e1rio pode enviar este token como cabe\u00e7alhos em sua solicita\u00e7\u00e3o 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
Copiar arquivo do servidor remoto usando Guzzle<\/h4>\n
Se voc\u00ea deseja copiar um arquivo de um servidor remoto para o diret\u00f3rio local, o Guzzle ser\u00e1 uma op\u00e7\u00e3o melhor. Digamos que voc\u00ea queira copiar esta imagem em https:\/\/artisansweb.net\/wp-content\/uploads\/2020\/03\/blog.jpg<\/a> como ‘blog.jpg’ para seu diret\u00f3rio local. Vamos escrever o c\u00f3digo para ele conforme mostrado abaixo.<\/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
Upload de arquivo usando Guzzle<\/h4>\n
Como todos sabemos, para enviar arquivos, precisamos definir o corpo da solicita\u00e7\u00e3o como um formul\u00e1rio ‘multipart \/ form-data’. O c\u00f3digo b\u00e1sico no Guzzle para upload de arquivos seria escrito como abaixo.<\/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
Para demonstrar o upload do arquivo, pegarei<\/a> um exemplo ao vivo da API reSmush.it<\/a> que envia uma vers\u00e3o otimizada da imagem em resposta. Voc\u00ea precisa POSTAR sua imagem em seu endpoint. O c\u00f3digo para ele usando Guzzle da seguinte maneira.<\/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
PUT, PATCH e DELETE Request using Guzzle<\/h3>\n
As solicita\u00e7\u00f5es PUT e PATCH s\u00e3o usadas para atualizar os recursos. No entanto, essas 2 solicita\u00e7\u00f5es fazem isso de maneira diferente.<\/p>\n
PUT sobrescreve toda a entidade, se ela j\u00e1 existir, e cria um novo recurso, se ainda n\u00e3o existir. Se voc\u00ea deseja atualizar o nome de uma pessoa, voc\u00ea precisa enviar todo o recurso ao fazer uma solicita\u00e7\u00e3o 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
A solicita\u00e7\u00e3o PATCH aplica uma atualiza\u00e7\u00e3o parcial ao recurso. Isso significa que voc\u00ea s\u00f3 precisa enviar os dados que deseja atualizar e n\u00e3o afetar\u00e1 ou alterar\u00e1 mais nada. Portanto, se voc\u00ea deseja atualizar o nome de uma pessoa, ser\u00e1 necess\u00e1rio apenas enviar o par\u00e2metro 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
Uma solicita\u00e7\u00e3o DELETE \u00e9 direta. Voc\u00ea s\u00f3 precisa atingir o ponto de extremidade da seguinte maneira.<\/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
Espero que voc\u00ea conhe\u00e7a o Guzzle e os princ\u00edpios b\u00e1sicos de como us\u00e1-lo. Voc\u00ea pode ler mais sobre Guzzle Request Options em sua documenta\u00e7\u00e3o<\/a>. Por favor, compartilhe suas id\u00e9ias ou sugest\u00f5es na se\u00e7\u00e3o de coment\u00e1rios abaixo.<\/p>\n
Artigos relacionados<\/h4>\n