README.md
1![Guzzle](.github/logo.png?raw=true)
2
3# Guzzle, PHP HTTP client
4
5[![Latest Version](https://img.shields.io/github/release/guzzle/guzzle.svg?style=flat-square)](https://github.com/guzzle/guzzle/releases)
6[![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)
7[![Total Downloads](https://img.shields.io/packagist/dt/guzzlehttp/guzzle.svg?style=flat-square)](https://packagist.org/packages/guzzlehttp/guzzle)
8
9Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and
10trivial to integrate with web services.
11
12- Simple interface for building query strings, POST requests, streaming large
13 uploads, streaming large downloads, using HTTP cookies, uploading JSON data,
14 etc...
15- Can send both synchronous and asynchronous requests using the same interface.
16- Uses PSR-7 interfaces for requests, responses, and streams. This allows you
17 to utilize other PSR-7 compatible libraries with Guzzle.
18- Supports PSR-18 allowing interoperability between other PSR-18 HTTP Clients.
19- Abstracts away the underlying HTTP transport, allowing you to write
20 environment and transport agnostic code; i.e., no hard dependency on cURL,
21 PHP streams, sockets, or non-blocking event loops.
22- Middleware system allows you to augment and compose client behavior.
23
24```php
25$client = new \GuzzleHttp\Client();
26$response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');
27
28echo $response->getStatusCode(); // 200
29echo $response->getHeaderLine('content-type'); // 'application/json; charset=utf8'
30echo $response->getBody(); // '{"id": 1420053, "name": "guzzle", ...}'
31
32// Send an asynchronous request.
33$request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org');
34$promise = $client->sendAsync($request)->then(function ($response) {
35 echo 'I completed! ' . $response->getBody();
36});
37
38$promise->wait();
39```
40
41## Help and docs
42
43We use GitHub issues only to discuss bugs and new features. For support please refer to:
44
45- [Documentation](http://guzzlephp.org/)
46- [Stack Overflow](http://stackoverflow.com/questions/tagged/guzzle)
47- [#guzzle](https://app.slack.com/client/T0D2S9JCT/CE6UAAKL4) channel on [PHP-HTTP Slack](http://slack.httplug.io/)
48- [Gitter](https://gitter.im/guzzle/guzzle)
49
50
51## Installing Guzzle
52
53The recommended way to install Guzzle is through
54[Composer](https://getcomposer.org/).
55
56```bash
57composer require guzzlehttp/guzzle
58```
59
60
61## Version Guidance
62
63| Version | Status | Packagist | Namespace | Repo | Docs | PSR-7 | PHP Version |
64|---------|------------|---------------------|--------------|---------------------|---------------------|-------|-------------|
65| 3.x | EOL | `guzzle/guzzle` | `Guzzle` | [v3][guzzle-3-repo] | [v3][guzzle-3-docs] | No | >= 5.3.3 |
66| 4.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v4][guzzle-4-repo] | N/A | No | >= 5.4 |
67| 5.x | EOL | `guzzlehttp/guzzle` | `GuzzleHttp` | [v5][guzzle-5-repo] | [v5][guzzle-5-docs] | No | >= 5.4 |
68| 6.x | Security fixes | `guzzlehttp/guzzle` | `GuzzleHttp` | [v6][guzzle-6-repo] | [v6][guzzle-6-docs] | Yes | >= 5.5 |
69| 7.x | Latest | `guzzlehttp/guzzle` | `GuzzleHttp` | [v7][guzzle-7-repo] | [v7][guzzle-7-docs] | Yes | >= 7.2 |
70
71[guzzle-3-repo]: https://github.com/guzzle/guzzle3
72[guzzle-4-repo]: https://github.com/guzzle/guzzle/tree/4.x
73[guzzle-5-repo]: https://github.com/guzzle/guzzle/tree/5.3
74[guzzle-6-repo]: https://github.com/guzzle/guzzle/tree/6.5
75[guzzle-7-repo]: https://github.com/guzzle/guzzle
76[guzzle-3-docs]: http://guzzle3.readthedocs.org
77[guzzle-5-docs]: http://docs.guzzlephp.org/en/5.3/
78[guzzle-6-docs]: http://docs.guzzlephp.org/en/6.5/
79[guzzle-7-docs]: http://docs.guzzlephp.org/en/latest/
80