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.

79 lines
3.8 KiB

3 years ago
  1. ![Guzzle](.github/logo.png?raw=true)
  2. # Guzzle, PHP HTTP client
  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/github/workflow/status/guzzle/guzzle/CI?label=ci%20build&style=flat-square)](https://github.com/guzzle/guzzle/actions?query=workflow%3ACI)
  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. - Supports PSR-18 allowing interoperability between other PSR-18 HTTP Clients.
  15. - Abstracts away the underlying HTTP transport, allowing you to write
  16. environment and transport agnostic code; i.e., no hard dependency on cURL,
  17. PHP streams, sockets, or non-blocking event loops.
  18. - Middleware system allows you to augment and compose client behavior.
  19. ```php
  20. $client = new \GuzzleHttp\Client();
  21. $response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');
  22. echo $response->getStatusCode(); // 200
  23. echo $response->getHeaderLine('content-type'); // 'application/json; charset=utf8'
  24. echo $response->getBody(); // '{"id": 1420053, "name": "guzzle", ...}'
  25. // Send an asynchronous request.
  26. $request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org');
  27. $promise = $client->sendAsync($request)->then(function ($response) {
  28. echo 'I completed! ' . $response->getBody();
  29. });
  30. $promise->wait();
  31. ```
  32. ## Help and docs
  33. We use GitHub issues only to discuss bugs and new features. For support please refer to:
  34. - [Documentation](http://guzzlephp.org/)
  35. - [Stack Overflow](http://stackoverflow.com/questions/tagged/guzzle)
  36. - [#guzzle](https://app.slack.com/client/T0D2S9JCT/CE6UAAKL4) channel on [PHP-HTTP Slack](http://slack.httplug.io/)
  37. - [Gitter](https://gitter.im/guzzle/guzzle)
  38. ## Installing Guzzle
  39. The recommended way to install Guzzle is through
  40. [Composer](https://getcomposer.org/).
  41. ```bash
  42. composer require guzzlehttp/guzzle
  43. ```
  44. ## Version Guidance
  45. | Version | Status | Packagist | Namespace | Repo | Docs | PSR-7 | PHP Version |
  46. |---------|------------|---------------------|--------------|---------------------|---------------------|-------|-------------|
  47. | 3.x | EOL | `guzzle/guzzle` | `Guzzle` | [v3][guzzle-3-repo] | [v3][guzzle-3-docs] | No | >= 5.3.3 |
  48. | 4.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v4][guzzle-4-repo] | N/A | No | >= 5.4 |
  49. | 5.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v5][guzzle-5-repo] | [v5][guzzle-5-docs] | No | >= 5.4 |
  50. | 6.x | Security fixes | `guzzlehttp/guzzle` | `GuzzleHttp` | [v6][guzzle-6-repo] | [v6][guzzle-6-docs] | Yes | >= 5.5 |
  51. | 7.x | Latest | `guzzlehttp/guzzle` | `GuzzleHttp` | [v7][guzzle-7-repo] | [v7][guzzle-7-docs] | Yes | >= 7.2 |
  52. [guzzle-3-repo]: https://github.com/guzzle/guzzle3
  53. [guzzle-4-repo]: https://github.com/guzzle/guzzle/tree/4.x
  54. [guzzle-5-repo]: https://github.com/guzzle/guzzle/tree/5.3
  55. [guzzle-6-repo]: https://github.com/guzzle/guzzle/tree/6.5
  56. [guzzle-7-repo]: https://github.com/guzzle/guzzle
  57. [guzzle-3-docs]: http://guzzle3.readthedocs.org
  58. [guzzle-5-docs]: http://docs.guzzlephp.org/en/5.3/
  59. [guzzle-6-docs]: http://docs.guzzlephp.org/en/6.5/
  60. [guzzle-7-docs]: http://docs.guzzlephp.org/en/latest/