Browse Source

Documentation updates

reviewable/pr1984/r1
Adam Byrtek 10 years ago committed by Markus Unterwaditzer
parent
commit
5ebdd5dd74
  1. 4
      docs/api.rst
  2. 4
      docs/testing.rst
  3. 2
      flask/wrappers.py

4
docs/api.rst

@ -29,7 +29,7 @@ Incoming Request Data
---------------------
.. autoclass:: Request
:members:
:members: is_json, get_json
.. attribute:: form
@ -141,7 +141,7 @@ Response Objects
----------------
.. autoclass:: flask.Response
:members: set_cookie, data, mimetype
:members: set_cookie, data, mimetype, is_json, get_json
.. attribute:: headers

4
docs/testing.rst

@ -362,7 +362,7 @@ Testing JSON APIs
Flask has great support for JSON, and is a popular choice for building REST
APIs. Testing both JSON requests and responses using the test client is very
convenient:
convenient::
from flask import jsonify
@ -371,12 +371,14 @@ convenient:
json_data = request.get_json()
email = json_data['email']
password = json_data['password']
return jsonify(token=generate_token(email, password))
with app.test_client() as c:
email = 'john@example.com'
password = 'secret'
resp = c.post('/api/auth', json={'login': email, 'password': password})
json_data = resp.get_json()
assert verify_token(email, json_data['token'])

2
flask/wrappers.py

@ -57,7 +57,7 @@ class JSONMixin(object):
return self.data
def get_json(self, force=False, silent=False, cache=True):
"""Parses the incoming JSON request data and returns it. By default
"""Parses the JSON request/response data and returns it. By default
this function will return ``None`` if the mimetype is not
:mimetype:`application/json` but this can be overridden by the
``force`` parameter. If parsing fails the

Loading…
Cancel
Save