Guzzlehttp - Как получить тело ответ от Guzzle 6?

163

Я пытаюсь написать обертку вокруг API, который разрабатывает моя компания. Это удобно, и с помощью Почтальона я могу отправить запрос на отправку в конечную точку, например, http://subdomain.dev.myapi.com/api/v1/auth/с именем пользователя и паролем в качестве данных POST, и мне возвращается токен. Все работает как положено. Теперь, когда я пытаюсь сделать то же самое из PHP, я получаю обратноGuzzleHttp\Psr7\Response объект, но, похоже, не могу найти токен внутри него, как я делал с запросом Postman.

Соответствующий код выглядит так:

$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...

Вывод кода выше выглядит примерно так (предупреждение, входящая стена текста):

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) {
    }
  }
}

Вывод почтальона был примерно таким:

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

Очевидно, я что-то упускаю из работы с объектами ответа в Guzzle. Ответ Guzzle указывает 200 код состояния на запрос, поэтому я не совсем уверен, что мне нужно сделать, чтобы получить возвращенные данные.

Greg
источник
33
$response->getBody()->getContents()не работает?
Федеркун

Ответы:

437

Жадность реализует ПСР-7 . Это означает, что по умолчанию он будет хранить тело сообщения в потоке, который использует временные потоки PHP. Чтобы получить все данные, вы можете использовать оператор приведения:

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

Вы также можете сделать это с

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

Разница между этими двумя подходами состоит в том, что getContentsвозвращает оставшееся содержимое, так что второй вызов ничего не возвращает, если вы не ищите позицию потока с помощью rewindили 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

Вместо этого, используя PHP операции приведения строк, он будет считывать все данные из потока от начала до конца.

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

Документация: http://docs.guzzlephp.org/en/latest/psr7.html#responses

Federkun
источник
5
Функция getContents есть только в одной небольшой части документации по Guzzle 6 (в разделе потоков), и я ее пропустил. Вы спасли меня от многих поисков.
Максимус
58
СПАСИБО. Невероятно, что это не более ясно в документации. Даже из их официальной документации ( docs.guzzlephp.org/en/latest ) кажется, что вызов $ res-> getBody () возвращает то, что вы обычно ожидаете.
Джон
24
Они действительно должны поместить что-то вроде примечания или уведомления в официальные документы. Я потратил два дня на этот вопрос.
cwhsu
+1 Документация Guzzle ложно утверждает, что "you can pass true to this method [getBody()] to retrieve the body as a string.". Это не работает для меня, используя Guzzle 6, но приведение к строке или использование getContents () работает.
Магнус W
8
Вы также можете использовать json_decode. Например, оберните ваш ответ в json_decode($response, true);это вернет массив.
Sygon
13

Если вы ожидаете возвращения JSON, самый простой способ получить его:

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

// OR

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

json_decode()автоматически приведёт тело к string, так что звонить не нужно getContents().

Максим Иванов
источник
1
Почему этот ответ не привлекает больше внимания ??? Это именно то, что мне было нужно. Спасибо @MaskimIvanov
Эрик Маквиннер
Это была самая простая и легкая вещь для меня тоже. Спасибо
Alator