DRF installation and setup in Django - Step-by-Step Execution

Concept Flow - DRF installation and setup

Start: New Django Project

↓

Install DRF package

↓

Add 'rest_framework' to INSTALLED_APPS

↓

Run migrations

↓

Create API views and serializers

↓

Run server and test API

This flow shows the steps to add Django REST Framework to a Django project, from installation to running the API server.

Execution Sample

Django

pip install djangorestframework

# settings.py
INSTALLED_APPS = [
    ...
    'rest_framework',
]

python manage.py migrate

This code installs DRF, adds it to the project settings, and applies migrations.

Execution Table

Step	Action	Result	Notes
1	Run 'pip install djangorestframework'	DRF package installed	Ready to use DRF in project
2	Add 'rest_framework' to INSTALLED_APPS	'rest_framework' registered	Django knows to load DRF
3	Run 'python manage.py migrate'	Migrations applied	DRF database tables created if needed
4	Create API views and serializers	API endpoints ready	Prepare to serve data
5	Run 'python manage.py runserver'	Server running	API accessible at localhost
6	Test API with browser or tool	API responds	Verify setup success

💡 Setup complete, API ready to use

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 5
DRF package	Not installed	Installed	Installed	Installed	Installed and active
INSTALLED_APPS	No 'rest_framework'	No change	Includes 'rest_framework'	Includes 'rest_framework'	Includes 'rest_framework'
Migrations	Not applied	Not applied	Not applied	Applied	Applied
Server status	Stopped	Stopped	Stopped	Stopped	Running

Key Moments - 3 Insights

Why do we add 'rest_framework' to INSTALLED_APPS after installing the package?

Adding 'rest_framework' to INSTALLED_APPS tells Django to load DRF features; without it, DRF won't work even if installed (see execution_table step 2).

What happens if we skip running migrations after adding DRF?

Skipping migrations means DRF's database tables won't be created, which can cause errors when using features that need database models (see execution_table step 3).

Why do we test the API after running the server?

Testing confirms the API endpoints respond correctly, verifying the setup is successful and the server is running (see execution_table step 6).

Visual Quiz - 3 Questions

Look at the execution_table, what is the result after step 2?

A DRF package installed

B 'rest_framework' registered

C Server running

D Migrations applied

💡 Hint

Check the 'Result' column for step 2 in execution_table

At which step does the server start running?

A Step 5

B Step 4

C Step 3

D Step 6

💡 Hint

Look at the 'Action' and 'Result' columns in execution_table for server status

If we forget to add 'rest_framework' to INSTALLED_APPS, what will happen?

A Server won't start

B Migrations will fail

C DRF features won't load even if installed

D API will work normally

💡 Hint

Refer to key_moments about importance of INSTALLED_APPS

Concept Snapshot

DRF Installation & Setup:
1. Run 'pip install djangorestframework'
2. Add 'rest_framework' to INSTALLED_APPS in settings.py
3. Run 'python manage.py migrate' to apply migrations
4. Create API views and serializers
5. Run server with 'python manage.py runserver'
6. Test API endpoints to confirm setup

Full Transcript

To set up Django REST Framework (DRF), first install it using pip. Then, add 'rest_framework' to your Django project's INSTALLED_APPS list so Django loads DRF features. Next, run migrations to prepare the database. After that, create your API views and serializers to define how data is handled. Finally, run the development server and test your API endpoints to ensure everything works. This process enables your Django project to serve RESTful APIs using DRF.

Practice

1. What is the first step to add Django REST Framework (DRF) to your Django project?

easy

A. Include DRF URLs in urls.py

B. Add rest_framework to INSTALLED_APPS

C. Install DRF using pip install djangorestframework

D. Run python manage.py migrate

Solution

1. Step 1: Install DRF package

   You must first install the Django REST Framework package using pip to add API features.

2. Step 2: Prepare for configuration

   After installation, you can add it to your Django settings and URLs.

3. Final Answer:

   Install DRF using pip -> Option C

4. Quick Check:

   First step = Install DRF [OK]

Hint: Always install packages before configuring [OK]

Common Mistakes:

• Trying to add to INSTALLED_APPS before installing
• Skipping installation and expecting DRF to work
• Running migrations before installing DRF

2. Which line correctly adds Django REST Framework to your Django settings?

easy

A. 'rest_framework' in INSTALLED_APPS

B. 'rest_framework' in DATABASES

C. 'rest_framework' in TEMPLATES

D. 'rest_framework' in MIDDLEWARE

Solution

1. Step 1: Locate the correct settings list

   Django apps are added to the INSTALLED_APPS list in settings.py.

2. Step 2: Add DRF to INSTALLED_APPS

   Adding 'rest_framework' here enables Django to recognize DRF features.

3. Final Answer:

   'rest_framework' in INSTALLED_APPS -> Option A

4. Quick Check:

   DRF goes in INSTALLED_APPS [OK]

Hint: Apps go in INSTALLED_APPS, not middleware or databases [OK]

Common Mistakes:

• Adding DRF to MIDDLEWARE instead of INSTALLED_APPS
• Placing DRF in TEMPLATES or DATABASES sections
• Forgetting to add DRF to settings after installation

3. Given this urls.py snippet, what does it enable?

from django.urls import path, include

urlpatterns = [
    path('api-auth/', include('rest_framework.urls')),
]

medium

A. It registers all API views automatically

B. It adds API login and logout pages for DRF's browsable API

C. It disables Django admin interface

D. It sets up database migrations for DRF

Solution

1. Step 1: Understand the included URL

   The rest_framework.urls include login and logout views for the browsable API.

2. Step 2: Recognize the effect on API interface

   This enables users to log in and out when using the DRF web interface.

3. Final Answer:

   It adds API login and logout pages for DRF's browsable API -> Option B

4. Quick Check:

   Including rest_framework.urls = API login/logout [OK]

Hint: Including rest_framework.urls adds API login/logout pages [OK]

Common Mistakes:

• Thinking it registers API views automatically
• Confusing it with admin site URLs
• Assuming it runs migrations or database setup

4. You added rest_framework to INSTALLED_APPS but get an error: ModuleNotFoundError: No module named 'rest_framework'. What is the likely cause?

medium

A. You forgot to install DRF with pip

B. You added 'rest_framework' to MIDDLEWARE instead of INSTALLED_APPS

C. You did not include DRF URLs in urls.py

D. You need to run python manage.py migrate first

Solution

1. Step 1: Understand the error meaning

   ModuleNotFoundError means Python cannot find the DRF package installed.

2. Step 2: Check installation status

   This usually happens if you forgot to run pip install djangorestframework.

3. Final Answer:

   You forgot to install DRF with pip -> Option A

4. Quick Check:

   ModuleNotFoundError = Missing pip install [OK]

Hint: ModuleNotFoundError means package not installed [OK]

Common Mistakes:

• Assuming adding to INSTALLED_APPS installs the package
• Thinking missing URLs cause this error
• Running migrate does not fix missing package

5. You want to enable the browsable API login/logout pages and have installed DRF and added it to INSTALLED_APPS. Which is the correct way to update your project's urls.py to achieve this?

hard

A. Add path('api-auth/', include('rest_framework.authentication')) to urlpatterns

B. Add path('api-auth/', include('django.contrib.auth.urls')) to urlpatterns

C. Add path('api-auth/', include('rest_framework.views')) to urlpatterns

D. Add path('api-auth/', include('rest_framework.urls')) to urlpatterns

Solution

1. Step 1: Identify the correct URL include for DRF login/logout

   The DRF package provides rest_framework.urls for login/logout views.

2. Step 2: Add the correct path to urlpatterns

   Use path('api-auth/', include('rest_framework.urls')) to enable these pages.

3. Final Answer:

   Add path('api-auth/', include('rest_framework.urls')) to urlpatterns -> Option D

4. Quick Check:

   DRF login/logout URLs = rest_framework.urls [OK]

Hint: Use rest_framework.urls for API auth URLs [OK]

Common Mistakes:

• Using django.contrib.auth.urls instead of DRF URLs
• Trying to include authentication or views modules directly
• Forgetting to include URLs after installing DRF