You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.6 KiB

4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. Guzzle, PHP HTTP client
  2. =======================
  3. [![Latest Version](https://img.shields.io/github/release/guzzle/guzzle.svg?style=flat-square)](https://github.com/guzzle/guzzle/releases)
  4. [![Build Status](https://img.shields.io/travis/guzzle/guzzle.svg?style=flat-square)](https://travis-ci.org/guzzle/guzzle)
  5. [![Total Downloads](https://img.shields.io/packagist/dt/guzzlehttp/guzzle.svg?style=flat-square)](https://packagist.org/packages/guzzlehttp/guzzle)
  6. Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and
  7. trivial to integrate with web services.
  8. - Simple interface for building query strings, POST requests, streaming large
  9. uploads, streaming large downloads, using HTTP cookies, uploading JSON data,
  10. etc...
  11. - Can send both synchronous and asynchronous requests using the same interface.
  12. - Uses PSR-7 interfaces for requests, responses, and streams. This allows you
  13. to utilize other PSR-7 compatible libraries with Guzzle.
  14. - Abstracts away the underlying HTTP transport, allowing you to write
  15. environment and transport agnostic code; i.e., no hard dependency on cURL,
  16. PHP streams, sockets, or non-blocking event loops.
  17. - Middleware system allows you to augment and compose client behavior.
  18. ```php
  19. $client = new \GuzzleHttp\Client();
  20. $response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');
  21. echo $response->getStatusCode(); # 200
  22. echo $response->getHeaderLine('content-type'); # 'application/json; charset=utf8'
  23. echo $response->getBody(); # '{"id": 1420053, "name": "guzzle", ...}'
  24. # Send an asynchronous request.
  25. $request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org');
  26. $promise = $client->sendAsync($request)->then(function ($response) {
  27. echo 'I completed! ' . $response->getBody();
  28. });
  29. $promise->wait();
  30. ```
  31. ## Help and docs
  32. - [Documentation](http://guzzlephp.org/)
  33. - [Stack Overflow](http://stackoverflow.com/questions/tagged/guzzle)
  34. - [Gitter](https://gitter.im/guzzle/guzzle)
  35. ## Installing Guzzle
  36. The recommended way to install Guzzle is through
  37. [Composer](http://getcomposer.org).
  38. ```bash
  39. # Install Composer
  40. curl -sS https://getcomposer.org/installer | php
  41. ```
  42. Next, run the Composer command to install the latest stable version of Guzzle:
  43. ```bash
  44. composer require guzzlehttp/guzzle
  45. ```
  46. After installing, you need to require Composer's autoloader:
  47. ```php
  48. require 'vendor/autoload.php';
  49. ```
  50. You can then later update Guzzle using composer:
  51. ```bash
  52. composer update
  53. ```
  54. ## Version Guidance
  55. | Version | Status | Packagist | Namespace | Repo | Docs | PSR-7 | PHP Version |
  56. |---------|------------|---------------------|--------------|---------------------|---------------------|-------|-------------|
  57. | 3.x | EOL | `guzzle/guzzle` | `Guzzle` | [v3][guzzle-3-repo] | [v3][guzzle-3-docs] | No | >= 5.3.3 |
  58. | 4.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v4][guzzle-4-repo] | N/A | No | >= 5.4 |
  59. | 5.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v5][guzzle-5-repo] | [v5][guzzle-5-docs] | No | >= 5.4 |
  60. | 6.x | Latest | `guzzlehttp/guzzle` | `GuzzleHttp` | [v6][guzzle-6-repo] | [v6][guzzle-6-docs] | Yes | >= 5.5 |
  61. [guzzle-3-repo]: https://github.com/guzzle/guzzle3
  62. [guzzle-4-repo]: https://github.com/guzzle/guzzle/tree/4.x
  63. [guzzle-5-repo]: https://github.com/guzzle/guzzle/tree/5.3
  64. [guzzle-6-repo]: https://github.com/guzzle/guzzle
  65. [guzzle-3-docs]: http://guzzle3.readthedocs.org
  66. [guzzle-5-docs]: http://guzzle.readthedocs.org/en/5.3/
  67. [guzzle-6-docs]: http://guzzle.readthedocs.org/en/latest/