Notes

######################## define function based API in drf with example
Function-based views (FBVs) in Django Rest Framework (DRF) provide a straightforward and concise way to create API endpoints. They are particularly useful for small to medium-sized projects.

*************************** Models.py *************************************
from django.db import models

class Item(models.Model):
name = models.CharField(max_length=100)
description = models.TextField()

def __str__(self):
return self.name


*********************** Serializer.py ************************************
# api/serializers.py
from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
class Meta:
model = Item
fields = '__all__'


********************* Views.py ********************************************
Create Function-Based Views
# api/views.py
from rest_framework.decorators import api_view
from rest_framework.response import Response
from .models import Item
from .serializers import ItemSerializer

@api_view(['GET', 'POST'])
def item_list(request):
if request.method == 'GET':
items = Item.objects.all()
serializer = ItemSerializer(items, many=True)
return Response(serializer.data)

elif request.method == 'POST':
serializer = ItemSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=201)
return Response(serializer.errors, status=400)


************************** URLs ***********************************************
# api/urls.py
from django.urls import path
from .views import item_list

urlpatterns = [
path('items/', item_list, name='item_list'),
]










######################## define class based API in drf with example which is inherit the class APIView.


*************************** Models.py *************************************

from django.db import models

class Book(models.Model):
title = models.CharField(max_length=200)
author = models.CharField(max_length=100)
published_date = models.DateField()

def __str__(self):
return self.title


*********************** Serializer.py ************************************
from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = '__all__'


********************* Views.py ********************************************
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from .models import Book
from .serializers import BookSerializer

class BookList(APIView):
"""
View to list all books or create a new book.
"""

def get(self, request):
books = Book.objects.all()
serializer = BookSerializer(books, many=True)
return Response(serializer.data)

def post(self, request):
serializer = BookSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

class BookDetail(APIView):
"""
View to retrieve, update or delete a book instance.
"""

def get_object(self, pk):
try:
return Book.objects.get(pk=pk)
except Book.DoesNotExist:
raise Http404

def get(self, request, pk):
book = self.get_object(pk)
serializer = BookSerializer(book)
return Response(serializer.data)

def put(self, request, pk):
book = self.get_object(pk)
serializer = BookSerializer(book, data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

def delete(self, request, pk):
book = self.get_object(pk)
book.delete()
return Response(status=status.HTTP_204_NO_CONTENT)


************************** URLs ***********************************************
from django.urls import path
from .views import BookList, BookDetail

urlpatterns = [
path('books/', BookList.as_view(), name='book_list'),
path('books/<int:pk>/', BookDetail.as_view(), name='book_detail'),
]





######################## define class based API in drf with example which is inherit the genericapiview and listmodelmixin.


*************************** Models.py *************************************
from django.db import models

class Article(models.Model):
title = models.CharField(max_length=200)
content = models.TextField()
published_date = models.DateField(auto_now_add=True)

def __str__(self):
return self.title


*********************** Serializer.py ************************************
from rest_framework import serializers
from .models import Article

class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = '__all__'


********************* Views.py ********************************************
from rest_framework import mixins
from rest_framework.generics import GenericAPIView
from .models import Article
from .serializers import ArticleSerializer

class ArticleList(mixins.ListModelMixin, mixins.CreateModelMixin, GenericAPIView):
"""
View to list all articles or create a new article.
"""
queryset = Article.objects.all()
serializer_class = ArticleSerializer

def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)

def post(self, request, *args, **kwargs):
return self.create(request, *args, **kwargs)

class ArticleDetail(mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
GenericAPIView):
"""
View to retrieve, update or delete an article instance.
"""
queryset = Article.objects.all()
serializer_class = ArticleSerializer

def get(self, request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)

def put(self, request, *args, **kwargs):
return self.update(request, *args, **kwargs)

def delete(self, request, *args, **kwargs):
return self.destroy(request, *args, **kwargs)


************************** URLs ***********************************************
from django.urls import path
from .views import ArticleList, ArticleDetail

urlpatterns = [
path('articles/', ArticleList.as_view(), name='article_list'),
path('articles/<int:pk>/', ArticleDetail.as_view(), name='article_detail'),
]


######################## define class based API in drf with example which is inherit the class VIEWset.


*************************** Models.py *************************************
from django.db import models

class Product(models.Model):
name = models.CharField(max_length=100)
description = models.TextField()
price = models.DecimalField(max_digits=10, decimal_places=2)

def __str__(self):
return self.name


*********************** Serializer.py ************************************
from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
class Meta:
model = Product
fields = '__all__'


********************* Views.py ********************************************
from rest_framework import viewsets
from .models import Product
from .serializers import ProductSerializer

class ProductViewSet(viewsets.ModelViewSet):
"""
A viewset for viewing and editing product instances.
"""
queryset = Product.objects.all()
serializer_class = ProductSerializer


************************** URLs ***********************************************
from django.contrib import admin
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from api.views import ProductViewSet

router = DefaultRouter()
router.register(r'products', ProductViewSet)

urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include(router.urls)), # Include the router URLs
]