diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 42202648..2e9f633f 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -228,6 +228,15 @@ For example, the GitHub API v3 accepts JSON-Encoded POST/PATCH data:: >>> payload = {'some': 'data'} >>> r = requests.post(url, data=json.dumps(payload)) + +Instead of encoding the ``dict`` yourself, you can also pass it directly using +the ``json`` parameter (added in version 2.4.2) and it will be encoded automatically: + + >>> import json + >>> url = 'https://api.github.com/some/endpoint' + >>> payload = {'some': 'data'} + + >>> r = requests.post(url, json=payload) POST a Multipart-Encoded File