DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
Building Scalable Real-Time Apps with AstraDB and Vaadin
Register Now

Trending

  • DevOps Midwest: A Community Event Full of DevSecOps Best Practices
  • How To Scan and Validate Image Uploads in Java
  • Five Java Books Beginners and Professionals Should Read
  • Application Architecture Design Principles

Trending

  • DevOps Midwest: A Community Event Full of DevSecOps Best Practices
  • How To Scan and Validate Image Uploads in Java
  • Five Java Books Beginners and Professionals Should Read
  • Application Architecture Design Principles
  1. DZone
  2. Coding
  3. Frameworks
  4. Create a Simple API Using Django REST Framework in Python

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.

Vinay R user avatar by
Vinay R
CORE ·
Jun. 02, 18 · Tutorial
Like (7)
Save
Tweet
Share
69.45K Views

Join the DZone community and get the full member experience.

Join For Free

Video

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.

Prerequisites

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:
'rest_framework',
 'MyApp',
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.

@api_view(["POST"])
def IdealWeight(heightdata):
    try:
        height=json.loads(heightdata.body)
        weight=str(height*10)

        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),
    url(r'^idealweight/',views.IdealWeight)
]

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 REST Web Protocols Django (web framework) Python (language) Framework

Opinions expressed by DZone contributors are their own.

Trending

  • DevOps Midwest: A Community Event Full of DevSecOps Best Practices
  • How To Scan and Validate Image Uploads in Java
  • Five Java Books Beginners and Professionals Should Read
  • Application Architecture Design Principles

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com

Let's be friends: