DRF installation and setup in Django - Mini Project: Build & Apply

DRF installation and setup

📖 Scenario: You are starting a new Django project and want to add REST API capabilities using Django REST Framework (DRF). This will allow your project to handle API requests easily.

🎯 Goal: Set up Django REST Framework in your Django project by installing the package, adding it to your project settings, and creating a simple API app structure.

📋 What You'll Learn

Install Django REST Framework package

Add 'rest_framework' to the INSTALLED_APPS list in settings.py

Create a new Django app called 'api'

Include the 'api' app in INSTALLED_APPS

💡 Why This Matters

🌍 Real World

Many web projects need to provide data through APIs for mobile apps or frontend frameworks. Setting up DRF is the first step to build these APIs.

💼 Career

Knowing how to install and configure Django REST Framework is essential for backend developers working with Django to create RESTful APIs.

1

Install Django REST Framework package

Run the command pip install djangorestframework in your terminal to install the Django REST Framework package.

Django

# Run pip install djangorestframework in your terminal
# Your code here

Hint

Use the pip tool to install the package named djangorestframework.

2

Add 'rest_framework' to INSTALLED_APPS in settings.py

In your Django project's settings.py file, add the string 'rest_framework' to the INSTALLED_APPS list.

Django

# Add 'rest_framework' to INSTALLED_APPS list
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # Your code here
]

Hint

Find the INSTALLED_APPS list in settings.py and add 'rest_framework' as a new item.

3

Create a new Django app called 'api'

Run the command python manage.py startapp api in your terminal to create a new app named api.

Django

# Run python manage.py startapp api in your terminal
# Your code here

Hint

Use Django's management command startapp to create a new app folder named api.

4

Add the 'api' app to INSTALLED_APPS

In your settings.py file, add the string 'api' to the INSTALLED_APPS list below 'rest_framework'.

Django

# Add 'api' to INSTALLED_APPS list in settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    # Your code here
]

Hint

Open settings.py and add 'api' to the INSTALLED_APPS list after 'rest_framework'.

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