Returning JSON with JsonResponse in Django

Introduction

JsonResponse helps you send data from your Django app to the browser in a simple way. It turns Python data into JSON format automatically.

When you want to send data to a web page without reloading it, like updating a list or showing new info.

When building APIs that other apps or websites can use to get data from your Django app.

When you want to respond to a form submission with data instead of a new page.

When you need to send status messages or small data packets to JavaScript running in the browser.

Syntax

Django

from django.http import JsonResponse

def my_view(request):
    return JsonResponse(data, safe=True, json_dumps_params=None)

data is usually a Python dictionary or list that you want to send as JSON.

The safe parameter defaults to True, which means only dictionaries are allowed unless you set it to False.

Examples

Sends a simple JSON object with a greeting message.

Django

from django.http import JsonResponse

def my_view(request):
    data = {'message': 'Hello, world!'}
    return JsonResponse(data)

Sends a JSON list by setting safe=False because lists are not allowed by default.

Django

from django.http import JsonResponse

def my_view(request):
    data = ['apple', 'banana', 'cherry']
    return JsonResponse(data, safe=False)

Sends the current time as a string in JSON format.

Django

from django.http import JsonResponse
import datetime

def my_view(request):
    data = {'time': datetime.datetime.now().isoformat()}
    return JsonResponse(data)

Sample Program

This Django view sends a JSON response with a greeting message when you visit the URL /greet/.

Django

from django.http import JsonResponse
from django.urls import path

# Simple view that returns JSON data

def greet_view(request):
    data = {'greeting': 'Hello from Django!'}
    return JsonResponse(data)

# URL patterns for Django
urlpatterns = [
    path('greet/', greet_view),
]

Important Notes

Always use JsonResponse instead of manually creating HTTP responses with JSON strings. It handles content type and encoding for you.

Remember to set safe=False if you want to return a list or other non-dictionary JSON data.

Use json_dumps_params to customize JSON formatting, like indentation for easier reading during development.

Summary

JsonResponse makes sending JSON data from Django easy and safe.

Use it to send dictionaries by default, or set safe=False for lists.

It automatically sets the right headers so browsers and clients know the response is JSON.

Practice

1. What is the main purpose of Django's JsonResponse class?

easy

A. To send JSON data as an HTTP response easily and safely

B. To render HTML templates with JSON data

C. To parse JSON data from incoming requests

D. To convert JSON strings into Python dictionaries

Solution

1. Step 1: Understand JsonResponse role

   JsonResponse is designed to send JSON data back to the client as an HTTP response.

2. Step 2: Differentiate from other JSON tasks

   It does not parse incoming JSON or render HTML; it only sends JSON safely with correct headers.

3. Final Answer:

   To send JSON data as an HTTP response easily and safely -> Option A

4. Quick Check:

   JsonResponse sends JSON response [OK]

Hint: JsonResponse sends JSON data back to clients [OK]

Common Mistakes:

• Confusing JsonResponse with JSON parsing
• Thinking it renders HTML templates
• Assuming it converts JSON strings to dicts

2. Which of the following is the correct way to return a JSON response with a dictionary {"name": "Alice"} using JsonResponse?

easy

A. return JsonResponse([{"name": "Alice"}], safe=False)

B. return JsonResponse({"name": "Alice"})

C. return JsonResponse('[{"name": "Alice"}]')

D. return JsonResponse(json.dumps({"name": "Alice"}))

Solution

1. Step 1: Use JsonResponse with a dictionary

   JsonResponse accepts a dictionary by default and sets safe=True, so no extra argument is needed.

2. Step 2: Differentiate correct usage

   Passing a list of dictionaries produces a JSON array instead of a single object; passing JSON strings causes TypeError.

3. Final Answer:

   return JsonResponse({"name": "Alice"}) -> Option B

4. Quick Check:

   Dict input with default safe=True [OK]

Hint: Pass dict directly; no safe=False needed for dict [OK]

Common Mistakes:

• Passing JSON string instead of dict
• Passing a list produces JSON array instead of object
• Using json.dumps inside JsonResponse

3. What will be the output of this Django view code?

from django.http import JsonResponse

def my_view(request):
    data = [1, 2, 3]
    return JsonResponse(data, safe=False)

medium

A. HTTP response with JSON array [1, 2, 3]

B. TypeError because safe=False is invalid

C. HTTP response with JSON string '[1, 2, 3]'

D. HTTP response with JSON object {"data": [1, 2, 3]}

Solution

1. Step 1: Recognize safe=False allows list data

   JsonResponse by default requires dict; safe=False allows lists like [1, 2, 3].

2. Step 2: Understand output JSON content

   The response will contain the JSON array [1, 2, 3] as the body with correct headers.

3. Final Answer:

   HTTP response with JSON array [1, 2, 3] -> Option A

4. Quick Check:

   safe=False lets list output [OK]

Hint: Use safe=False to return lists as JSON [OK]

Common Mistakes:

• Omitting safe=False causes TypeError
• Expecting JSON object instead of array
• Confusing JSON string with JSON array

4. Identify the error in this Django view code:

from django.http import JsonResponse

def my_view(request):
    data = ["apple", "banana"]
    return JsonResponse(data)

medium

A. No error; code works fine

B. JsonResponse cannot return lists at all

C. JsonResponse requires json.dumps before returning

D. Missing safe=False causes TypeError for list data

Solution

1. Step 1: Check data type passed to JsonResponse

   Data is a list, but JsonResponse defaults to safe=True, which only allows dicts.

2. Step 2: Understand error cause

   Without safe=False, passing a list raises TypeError because it's unsafe to send raw lists.

3. Final Answer:

   Missing safe=False causes TypeError for list data -> Option D

4. Quick Check:

   List needs safe=False to avoid error [OK]

Hint: Add safe=False when returning lists [OK]

Common Mistakes:

• Forgetting safe=False with lists
• Trying to json.dumps before JsonResponse
• Assuming JsonResponse accepts lists by default

5. You want to return a JSON response with a list of user names ["Alice", "Bob"] from a Django view. Which is the correct way to do this?

hard

A. return JsonResponse({"users": ["Alice", "Bob"]})

B. return JsonResponse(["Alice", "Bob"], safe=True)

C. return JsonResponse(["Alice", "Bob"], safe=False)

D. return JsonResponse(json.dumps(["Alice", "Bob"]))

Solution

1. Step 1: Decide JSON structure to return

   Returning a list directly requires safe=False because JsonResponse defaults to safe=True (dict only).

2. Step 2: Avoid common mistakes

   Passing safe=True with a list causes error; json.dumps returns string, which JsonResponse does not accept.

3. Final Answer:

   return JsonResponse(["Alice", "Bob"], safe=False) -> Option C

4. Quick Check:

   List with safe=False returns JSON array [OK]

Hint: Use safe=False to return JSON lists directly [OK]

Common Mistakes:

• Setting safe=True with list causes error
• Passing JSON string instead of Python list
• Wrapping list inside dict unnecessarily