Guzzlehttp - Como obter o corpo de uma resposta do Guzzle 6?

163

Estou tentando escrever um invólucro em torno de uma API que minha empresa está desenvolvendo. É tranquilo e, usando o Postman, posso enviar uma solicitação de postagem para um endpoint, como http://subdomain.dev.myapi.com/api/v1/auth/um nome de usuário e senha como dados POST, e recebo um token. Tudo funciona como esperado. Agora, quando tento fazer o mesmo no PHP, recebo de volta um GuzzleHttp\Psr7\Responseobjeto, mas parece que não consigo encontrar o token em nenhum lugar, como fiz com a solicitação do Postman.

O código relevante se parece com:

$client = new Client(['base_uri' => 'http://companysub.dev.myapi.com/']);
$response = $client->post('api/v1/auth/', [
    'form_params' => [
        'username' => $user,
        'password' => $password
    ]
]);

var_dump($response); //or $resonse->getBody(), etc...

A saída do código acima se parece com (aviso, parede de texto recebida):

object(guzzlehttp\psr7\response)#36 (6) {
  ["reasonphrase":"guzzlehttp\psr7\response":private]=>
  string(2) "ok"
  ["statuscode":"guzzlehttp\psr7\response":private]=>
  int(200)
  ["headers":"guzzlehttp\psr7\response":private]=>
  array(9) {
    ["connection"]=>
    array(1) {
      [0]=>
      string(10) "keep-alive"
    }
    ["server"]=>
    array(1) {
      [0]=>
      string(15) "gunicorn/19.3.0"
    }
    ["date"]=>
    array(1) {
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    }
    ["transfer-encoding"]=>
    array(1) {
      [0]=>
      string(7) "chunked"
    }
    ["content-type"]=>
    array(1) {
      [0]=>
      string(16) "application/json"
    }
    ["allow"]=>
    array(1) {
      [0]=>
      string(13) "post, options"
    }
    ["x-frame-options"]=>
    array(1) {
      [0]=>
      string(10) "sameorigin"
    }
    ["vary"]=>
    array(1) {
      [0]=>
      string(12) "cookie, host"
    }
    ["via"]=>
    array(1) {
      [0]=>
      string(9) "1.1 vegur"
    }
  }
  ["headerlines":"guzzlehttp\psr7\response":private]=>
  array(9) {
    ["connection"]=>
    array(1) {
      [0]=>
      string(10) "keep-alive"
    }
    ["server"]=>
    array(1) {
      [0]=>
      string(15) "gunicorn/19.3.0"
    }
    ["date"]=>
    array(1) {
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    }
    ["transfer-encoding"]=>
    array(1) {
      [0]=>
      string(7) "chunked"
    }
    ["content-type"]=>
    array(1) {
      [0]=>
      string(16) "application/json"
    }
    ["allow"]=>
    array(1) {
      [0]=>
      string(13) "post, options"
    }
    ["x-frame-options"]=>
    array(1) {
      [0]=>
      string(10) "sameorigin"
    }
    ["vary"]=>
    array(1) {
      [0]=>
      string(12) "cookie, host"
    }
    ["via"]=>
    array(1) {
      [0]=>
      string(9) "1.1 vegur"
    }
  }
  ["protocol":"guzzlehttp\psr7\response":private]=>
  string(3) "1.1"
  ["stream":"guzzlehttp\psr7\response":private]=>
  object(guzzlehttp\psr7\stream)#27 (7) {
    ["stream":"guzzlehttp\psr7\stream":private]=>
    resource(40) of type (stream)
    ["size":"guzzlehttp\psr7\stream":private]=>
    null
    ["seekable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["readable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["writable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["uri":"guzzlehttp\psr7\stream":private]=>
    string(10) "php://temp"
    ["custommetadata":"guzzlehttp\psr7\stream":private]=>
    array(0) {
    }
  }
}

A saída do Postman era algo como:

{
    "data" : {
        "token" "fasdfasf-asfasdfasdf-sfasfasf"
    }
}

Claramente, estou sentindo falta de algo sobre como trabalhar com os objetos de resposta no Guzzle. A resposta Guzzle indica um código de status 200 na solicitação, portanto, não tenho certeza do que preciso fazer para recuperar os dados retornados.

Greg
fonte
33
$response->getBody()->getContents()não funciona?
Federkun 30/05

Respostas:

435

Guzzle implementa PSR-7 . Isso significa que, por padrão, ele armazenará o corpo de uma mensagem em um Stream que usa fluxos temporários de PHP. Para recuperar todos os dados, você pode usar o operador de conversão:

$contents = (string) $response->getBody();

Você também pode fazê-lo com

$contents = $response->getBody()->getContents();

A diferença entre as duas abordagens é que getContentsretorna o conteúdo restante, de modo que uma segunda chamada não retorna nada, a menos que você busque a posição do fluxo com rewindou seek.

$stream = $response->getBody();
$contents = $stream->getContents(); // returns all the contents
$contents = $stream->getContents(); // empty string
$stream->rewind(); // Seek to the beginning
$contents = $stream->getContents(); // returns all the contents

Em vez disso, usando as operações de conversão de string do PHP, ele lê todos os dados do fluxo desde o início até o fim.

$contents = (string) $response->getBody(); // returns all the contents
$contents = (string) $response->getBody(); // returns all the contents

Documentação: http://docs.guzzlephp.org/en/latest/psr7.html#responses

Federkun
fonte
5
A função getContents está apenas em uma pequena parte da documentação do Guzzle 6 (na seção de fluxos), e eu a perdi. Você me salvou de muitas pesquisas.
Maximus
58
OBRIGADO. É inacreditável que isso não fique mais claro na documentação. Até a documentação oficial ( docs.guzzlephp.org/en/latest ) faz parecer que chamar $ res-> getBody () retorna o que você normalmente esperaria.
João
24
Eles devem realmente colocar algo como uma nota ou aviso nos documentos oficiais. Eu perdi dois dias nessa questão.
precisa saber é
+1 A documentação do Guzzle afirma falsamente isso "you can pass true to this method [getBody()] to retrieve the body as a string.". Isso não parece funcionar para mim usando o Guzzle 6, mas converter para string ou usar getContents () funciona.
Magnus W
8
Você também pode usar json_decode. Por exemplo, envolva sua resposta com json_decode($response, true);isso retornará uma matriz.
Sygon
13

Se você espera o JSON de volta, a maneira mais simples de obtê-lo:

$data = json_decode($response->getBody()); // returns an object

// OR

$data = json_decode($response->getBody(), true); // returns an array

json_decode()converterá o corpo automaticamente para string, portanto, não há necessidade de ligar getContents().

Maksim Ivanov
fonte
1
Por que essa resposta não está recebendo mais atenção ??? Isto é precisamente o que eu precisava. Obrigado @MaskimIvanov
Eric McWinNEr
Essa foi a coisa mais simples e fácil para mim também. Obrigado
Alator 27/03