JSON responses with jsonify in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of jsonify in Flask?

jsonify converts Python data structures like dictionaries or lists into a JSON response Flask can send to the client. It also sets the correct content type application/json.

beginner

How do you return a JSON response with a status code using jsonify?

Return a tuple: return jsonify(data), status_code. For example, return jsonify({'message': 'ok'}), 200 sends JSON with HTTP status 200.

beginner

True or False: jsonify automatically sets the Content-Type header to application/json.

True. This helps browsers and clients understand the response is JSON data.

intermediate

What happens if you try to jsonify a Python object that is not JSON serializable?

Flask raises a TypeError because it cannot convert the object to JSON. You must convert or simplify the object first.

intermediate

Why is it better to use jsonify instead of json.dumps in Flask responses?

jsonify sets the correct headers and returns a Flask Response object directly. json.dumps only creates a JSON string, so you must manually set headers and response type.

What does jsonify do in Flask?

A Creates HTML responses

B Converts JSON to Python objects

C Converts Python data to JSON and sets response headers

D Starts the Flask server

jsonify converts Python data to JSON format and sets the response content type to application/json.

How do you send a JSON response with status 404 using jsonify?

A return jsonify({'error': 'Not found'})

B return jsonify(404, {'error': 'Not found'})

C return 404, jsonify({'error': 'Not found'})

D return jsonify({'error': 'Not found'}), 404

Return a tuple with jsonify output and status code: return jsonify(...), 404.

Which header does jsonify set automatically?

A Content-Type: text/html

B Content-Type: application/json

C Authorization

D Cache-Control

jsonify sets Content-Type to application/json so clients know the response is JSON.

What error occurs if you try to jsonify a non-serializable object?

A TypeError

B ValueError

C KeyError

D ImportError

Flask raises a TypeError when it cannot convert an object to JSON.

Why prefer jsonify over json.dumps in Flask?

A <code>jsonify</code> sets headers and returns a response object

B <code>json.dumps</code> is faster

C <code>json.dumps</code> sets headers automatically

D They are the same

jsonify handles headers and response creation, making it easier and safer to use in Flask.

Explain how to create and return a JSON response in Flask using jsonify.

Think about how Flask sends data to the browser in JSON format.

Describe what happens if you try to jsonify a Python object that Flask cannot convert to JSON.

Consider what JSON can represent and what Python objects might not fit.

Practice

1. What does the jsonify function in Flask do?

easy

A. Converts Python data to JSON and sets response headers correctly

B. Converts JSON data to Python objects

C. Creates HTML responses from Python dictionaries

D. Sends plain text responses without headers

Solution

1. Step 1: Understand the purpose of jsonify

   The jsonify function is designed to convert Python data structures like dictionaries or lists into JSON format.

2. Step 2: Recognize response headers setting

   It also automatically sets the HTTP response headers to indicate the content type is JSON, which is important for browsers or clients to understand the data format.

3. Final Answer:

   Converts Python data to JSON and sets response headers correctly -> Option A

4. Quick Check:

   jsonify converts data to JSON with headers [OK]

Hint: jsonify = Python data to JSON response with headers [OK]

Common Mistakes:

• Thinking jsonify converts JSON to Python
• Assuming jsonify creates HTML
• Ignoring response headers setup

2. Which of the following is the correct way to return a JSON response with jsonify in Flask?

easy

A. return jsonify('name', 'Alice', 'age', 30)

B. return json.dumps({'name': 'Alice', 'age': 30})

C. return jsonify({'name': 'Alice', 'age': 30})

D. return jsonify('name': 'Alice', 'age': 30)

Solution

1. Step 1: Check the syntax for jsonify with a dictionary

   The correct syntax is to pass a dictionary inside parentheses: jsonify({'key': value}).

2. Step 2: Identify the correct option

   return jsonify({'name': 'Alice', 'age': 30}) correctly uses a dictionary inside jsonify. return json.dumps({'name': 'Alice', 'age': 30}) uses json.dumps which returns a string, not a Flask response. return jsonify('name': 'Alice', 'age': 30) has incorrect syntax missing braces. return jsonify('name', 'Alice', 'age', 30) passes multiple positional arguments, causing a TypeError.

3. Final Answer:

   return jsonify({'name': 'Alice', 'age': 30}) -> Option C

4. Quick Check:

   jsonify expects a dict inside parentheses [OK]

Hint: Use jsonify with a dictionary inside parentheses [OK]

Common Mistakes:

• Using json.dumps instead of jsonify
• Passing key-value pairs without braces
• Passing multiple positional arguments to jsonify

3. What will be the output content type of this Flask route?

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/data')
def data():
    return jsonify({'success': True, 'count': 5})

medium

A. application/json

B. text/plain

C. text/html

D. application/xml

Solution

1. Step 1: Identify the response type from jsonify

   The jsonify function returns a Flask response with the content type set to application/json.

2. Step 2: Confirm the content type for JSON data

   Since the route returns jsonify({'success': True, 'count': 5}), the content type will be application/json.

3. Final Answer:

   application/json -> Option A

4. Quick Check:

   jsonify sets content type to application/json [OK]

Hint: jsonify always sets content type to application/json [OK]

Common Mistakes:

• Assuming default is text/html
• Confusing with plain text content type
• Thinking jsonify returns XML

4. Identify the error in this Flask route using jsonify:

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/info')
def info():
    data = {'name': 'Bob', 'age': 25}
    return jsonify(data['name'], data['age'])

medium

A. Route decorator syntax is wrong

B. Missing parentheses in jsonify call

C. Flask app not initialized correctly

D. jsonify expects a single dictionary or list, not multiple arguments

Solution

1. Step 1: Analyze the jsonify call arguments

   The code calls jsonify(data['name'], data['age']) passing two separate arguments instead of one dictionary or list.

2. Step 2: Understand jsonify argument requirements

   jsonify expects a single argument like a dictionary, list, or keyword arguments, not multiple positional arguments.

3. Final Answer:

   jsonify expects a single dictionary or list, not multiple arguments -> Option D

4. Quick Check:

   jsonify needs one dict/list argument [OK]

Hint: Pass one dict or list to jsonify, not multiple values [OK]

Common Mistakes:

• Passing multiple arguments to jsonify
• Confusing jsonify with print function
• Ignoring argument structure requirements

5. You want to return a JSON response with a list of users and a status message using jsonify. Which code correctly combines a list and a message in the JSON response?

hard

A. return jsonify(['Ann', 'Ben'], status='ok')

B. return jsonify({'users': ['Ann', 'Ben'], 'status': 'ok'})

C. return jsonify(users=['Ann', 'Ben'], 'status': 'ok')

D. return jsonify({'users': ['Ann', 'Ben']}, {'status': 'ok'})

Solution

1. Step 1: Understand how to combine data in jsonify

   To send multiple pieces of data, combine them into a single dictionary with keys and values.

2. Step 2: Evaluate each option

   return jsonify({'users': ['Ann', 'Ben'], 'status': 'ok'}) correctly creates one dictionary with keys 'users' and 'status'. return jsonify(['Ann', 'Ben'], status='ok') passes a list and a keyword argument, which is invalid. return jsonify(users=['Ann', 'Ben'], 'status': 'ok') mixes keyword arguments and dictionary syntax incorrectly. return jsonify({'users': ['Ann', 'Ben']}, {'status': 'ok'}) passes two dictionaries separately, which is not allowed.

3. Final Answer:

   return jsonify({'users': ['Ann', 'Ben'], 'status': 'ok'}) -> Option B

4. Quick Check:

   Combine all data in one dict for jsonify [OK]

Hint: Put all data in one dictionary before jsonify [OK]

Common Mistakes:

• Passing multiple arguments instead of one dict
• Mixing keyword args and dict syntax wrongly
• Trying to jsonify multiple separate dicts