Create a Simple API Using Django REST Framework in Python

DZone 's Guide to

Create a Simple API Using Django REST Framework in Python

Read this article in order to learn more about how to create a simple API using Django REST framework in Python.

· Integration Zone ·
Free Resource


Steps to Create a Simple Django REST API Project

In this Django API tutorial, we will create a simple API, which will accept the height (in feet) of a person and returns the ideal weight (in kgs) for that person to be.


Install either Python or the Anacondas distribution of Python.

Install the Django and Django REST frameworks with below commands:

  • pip install django
  • pip install djangorestframework

For the Anacondas Python distribution, use the below commands:

  • conda install django
  • conda install -c conda-forge djangorestframework

Step 1: Navigate to any folder you want in order to create the django project, open the command prompt there and enter the following command:

django-admin startproject SampleProject

Step2: Navigate to the project folder and create a web app using the below command:

python manage.py startapp MyApp

The project folder will look something like this:

Step 3: Open the settings.py file and add the below lines of code in the INSTALLED_APPS section:
Step4: Open views.py file inside MyApp folder and add the below lines of code:
from django.shortcuts import render
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.decorators import api_view
from rest_framework.response import Response
from rest_framework import status
from django.http import JsonResponse
from django.core import serializers
from django.conf import settings
import json

# Create your views here.

def IdealWeight(heightdata):

        return JsonResponse("Ideal weight should be:"+weight+" kg",safe=False)
    except ValueError as e:
        return Response(e.args[0],status.HTTP_400_BAD_REQUEST)

The IdealWeight(heightdate) is the method that gets executed when API call is made. It has a simple logic to calculate weight(=height*10). The line return JsonRespone(…) will send the response back.

Step5: Open urls.py file and add the below lines of code:
from django.conf.urls import url
from django.contrib import admin
from MyApp import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),

The line url(r^idealweight/,views.IdealWeight) basically tells us that the IdealWeight method will be called using the url http://<server ip>/idealweight/

Step6: We can start the api with below commands in command prompt:

python manage.py runserver

Finally, we can test the API using POSTMAN.

api, django, python programming, rest api

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}