rest_framework 學習筆記(一)

rest_framework

[TOC]

簡介

Django REST框架是一個功能強大且靈活的工具包，用於構建Web API。

官方網站：https://www.django-rest-framework.org

安裝與加載

pip install djangorestframework

INSTALLED_APPS = [
		...,
    'rest_framework'
]

序列化與反序列化流程

反序列化流程

反序列化流程 是從前端提交數據到數據庫的流程。

graph LR web提交數據 --> get/post...請求 get/post...請求 --> to_internal_value to_internal_value --> 序列化映射 序列化映射 --> 自定義字段驗證 自定義字段驗證 --> 對象級別驗證 對象級別驗證 --> action action --> to_representation

序列化流程

序列化是將數據從數據庫提交到前端的過程。

graph LR QuerySet --> serializer serializer --> to_representation to_representation --> 前端

序列化模型

建立 serializers.py文件

from rest_framework import serializers
from .models import Idc


class IdcSerializer(serializers.Serializer):
    """
    Idc 序列化類
    """
    id = serializers.IntegerField(read_only=True)
    name = serializers.CharField(required=True, max_length=32)
    address = serializers.CharField(required=True, max_length=256)
    phone = serializers.CharField(required=True, max_length=15)
    email = serializers.EmailField(required=True, max_length=50)
    letter = serializers.CharField(required=True, max_length=5)
    
    ### 定義create 與update 爲反序列化準備
    def create(self, validated_data):
        return Idc.objects.create(**validated_data)
      
    def update(self, instance, validated_data):
        instance.name = validated_data.get("name", instance.name)
        instance.address = validated_data.get("address", instance.name)
        instance.phone = validated_data.get("phone", instance.name)
        instance.email = validated_data.get("email", instance.name)
        instance.save()
        return instance

序列與反序列化方法

from django.utils.six import BytesIO
from rest_framework.parsers import JSONParser
from rest_framework.renderers import JSONRenderer

## 序列化
queryset = Idc.objects.all()
serializer = IdcSerializer(queryset, many=True)
ret = JSONRenderer().render(serializer)

## 反序列化
## content 前端傳入的byte 型字符串 

stream = BytesIO(content)
data = JSONParser().parse(stream)

serialize1 = IdcSerializer(data=data)
# 驗證數據合法性
serialize1.is_valid()
# 保存數據
serialize1.save()
# 獲取合法數據
serialize1.validated_data

view 邏輯實現

from .models import Idc
from rest_framework.decorators import api_view
from rest_framework import status
from rest_framework.response import Response
from .serializers import IdcSerializer

# ################ 版本2 ################
# 使用api_view 限制請求方式, 使用Response 簡化序列化流程

@api_view(["GET", "POST"])
def idc_list(request, *args, **kwargs):
    if request.method == "GET":
        print(request.path)
        queryset = Idc.objects.all()
        serializer = IdcSerializer(queryset, many=True)
        return Response(serializer.data)
    if request.method == "POST":
        serializer = IdcSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(status=status.HTTP_201_CREATED)
        return Response(status=status.HTTP_400_BAD_REQUEST)

@api_view(["GET", "PUT"])
def idc_detail(request, pk, *args, **kwargs):
    try:
        queryset = Idc.objects.get(pk=pk)
    except:
        return Response(status=status.HTTP_404_NOT_FOUND)

    if request.method == "GET":
        serializer = IdcSerializer(queryset)
        return Response(serializer.data)
    if request.method == "PUT":
        serializer = IdcSerializer(queryset, data=request.data)

        if serializer.is_valid():
            serializer.save()
            return Response(status=status.HTTP_202_ACCEPTED)
        return Response(status=status.HTTP_400_BAD_REQUEST)
        
# ################ 版本3 ################
# 使用類視圖進行改寫

from rest_framework.views import APIView
from django.http import Http404


class IdcList(APIView):
    def get(self, request, format=None):
        queryset = Idc.objects.all()
        serializer = IdcSerializer(queryset, many=True)
        return Response(serializer.data)

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

class IdcDetail(APIView):

    def get_obj(self, pk):
        try:
            Idc_obj = Idc.objects.get(pk=pk)
            return Idc_obj
        except Idc.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        queryset = self.get_obj(pk)
        serializer = IdcSerializer(queryset)
        return Response(serializer.data)

    def post(self, request, pk, format=None):

        queryset = self.get_obj(pk)
        serializer = IdcSerializer(queryset, data=request.data)

        if serializer.is_valid():
            serializer.save()
            return Response(status=status.HTTP_202_ACCEPTED)
        return Response(status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        queryset = self.get_obj(pk)
        queryset.delete()
        return Response(status.HTTP_204_NO_CONTENT)

# ################ 版本6 ################
# 使用混合, 將全部請求方法定義在一個視圖下

from rest_framework import viewsets


class IdcListV6(viewsets.GenericViewSet,
                mixins.RetrieveModelMixin,
                mixins.UpdateModelMixin,
                mixins.DestroyModelMixin,
                mixins.ListModelMixin,
                mixins.CreateModelMixin
                ):
    queryset = Idc.objects.all()
    serializer_class = IdcSerializer


# ################ 版本7 ################
# 簡化繼承關係

from rest_framework import viewsets


class IdcViewSetV7(viewsets.ModelViewSet):
    queryset = Idc.objects.all()
    serializer_class = IdcSerializer
from rest_framework.routers import DefaultRouter

註冊接口

from rest_framework.routers import DefaultRouter
route = DefaultRouter()
route.register("idcs", views.IdcViewSetV7)
urlpatterns = [
    url(r'^', include(route.urls))
]