Django Api Example - Api Creation In Django 

Building a Simple API with Django: A Step-by-Step Guide

APIs (Application Programming Interfaces) are a cornerstone of modern web development, enabling communication between different software systems. 

Django, a high-level Python web framework, simplifies the process of creating robust and scalable APIs. In this blog post, we’ll walk through building a simple API with Django.

Related posts:

Django Api Example - Api Creation In Django 

How to Secure Django Rest Api

How to Dockerize Your Django REST API

How to Use Django Redirect with URL Parameters

What is Django Allauth

Step 1: Setting Up the Project

First, ensure you have Django installed. You can install it via pip if you haven't already:

pip install django

Create a new Django project:

django-admin startproject myproject

cd myproject

Then, create a new app within your project:

python manage.py startapp myapp

Add the new app to your project's settings.py:

# myproject/settings.py

INSTALLED_APPS = [

    ...

    'myapp',

    'rest_framework',  # Add Django REST framework if you're using it

]

Step 2: Creating the Models

For this example, we’ll create a simple model for a Book:

# myapp/models.py

from django.db import models

class Book(models.Model):

    title = models.CharField(max_length=100)

    author = models.CharField(max_length=100)

    published_date = models.DateField()

    def __str__(self):

        return self.title

After defining the model, create and apply the migrations:

python manage.py makemigrations

python manage.py migrate

Step 3: Creating the Serializer

Serializers in Django REST Framework (DRF) convert complex data types, such as querysets and model instances, into native Python data types that can then be easily rendered into JSON or other content types.

Install Django REST Framework if you haven't already:

pip install djangorestframework

Create a serializer for the Book model:

# myapp/serializers.py

from rest_framework import serializers

from .models import Book

class BookSerializer(serializers.ModelSerializer):

    class Meta:

        model = Book

        fields = '__all__'

Step 4: Creating the Views

Next, create views to handle the API requests. We will use DRF's generic views for simplicity:

# myapp/views.py

from rest_framework import generics

from .models import Book

from .serializers import BookSerializer

class BookListCreateView(generics.ListCreateAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializer

class BookDetailView(generics.RetrieveUpdateDestroyAPIView):

    queryset = Book.objects.all()

    serializer_class = BookSerializer

Step 5: Setting Up the URLs

Configure the URLs to route the requests to the appropriate views:

# myapp/urls.py

from django.urls import path

from .views import BookListCreateView, BookDetailView

urlpatterns = [

    path('books/', BookListCreateView.as_view(), name='book-list-create'),

    path('books/<int:pk>/', BookDetailView.as_view(), name='book-detail'),

]

Include these URLs in the main project urls.py:

# myproject/urls.py

from django.contrib import admin

from django.urls import path, include

urlpatterns = [

    path('admin/', admin.site.urls),

    path('api/', include('myapp.urls')),  # Add this line

]

Step 6: Testing the API

Run the development server:

python manage.py runserver

You can now test your API endpoints using tools like Postman or curl. For example, to list all books, you can use:

curl http://127.0.0.1:8000/api/books/

To create a new book, you can send a POST request with the book data:

curl -X POST http://127.0.0.1:8000/api/books/ -d '{"title": "Sample Book", "author": "Author Name", "published_date": "2024-07-19"}' -H "Content-Type: application/json"

Conclusion

In this guide, we've covered the basics of setting up a simple API using Django and Django REST Framework. 

This example demonstrates the core principles and steps involved, providing a solid foundation for building more complex APIs. Happy coding!