Django REST framework 学习笔记（二）

• • Request对象
  • Response对象
  • 状态码
  • 包装API视图
  • 使用@api_view编写API视图
  • 使用APIView编写视图

Request对象

• REST framework 引入了一个

  Request

  对象，它是对

  HttpRequest

  的扩展，并提供灵活的请求解析

• Request

  对象的核心功能是

  request.data

  ，它类似于

  request.POST

  ，但对于使用Web API更加有用

request.POST   # 只能操作 form表单 数据，只能用于 'POST' 方法
request.data   # 可以操作任意的数据，并且能用于 'POST'、'PUT'、'PATCH' 方法
           

Response对象

• REST framework 还引入了一个

  Response

  对象，它是一种

  TemplateResponse

  对象
• 它能够使用协商好的类型，根据客户端请求的内容类型，呈现给客户端该类型的内容
• 例如：客户端请求

  json

  类型的数据，则呈现给客户端

  json

  类型数据

状态码

• 使用数字HTTP状态码并不能总是正确的显示出读数，如果代码是错误的的话
• REST framework 为每个状态码提供了专门的标识符，放在了

  status

  模块中
• 例如：

  status.HTTP_400_BAD_REQUEST

  ，表示状态码400

包装API视图

REST framework 提供了两个用于编写API视图的包装器

• @api_view

  是处理基于函数方法的API视图的一个装饰器

• APIView

  是基于类的API视图

这些包装器提供了一些功能，例如：确保

Request

在视图中能接收到实例对象，以及向

Response

对象添加内容以呈现给客户端

并且提供了一些动作行为，例如：在适当的时候返回

405 Method Not Allowed

响应，还有当访问

request.data

出现输入格式错误时抛出

ParseError

异常

使用@api_view编写API视图

在上一篇文章中的项目案例中，修改

views.py

文件，我们不再使用

JSONResponse

，所以用下面的代码替换掉文件的内容

from django.http import HttpResponse
from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response

from .models import Snippet
from .serializers import SnippetSerializer


@api_view(['GET', 'POST'])
def snippet_list(request, format=None):
    """
    列出所有代码段，或创建新代码段。
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        # data = JSONParser().parse(request)
        serializer = SnippetSerializer(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)


@api_view(['GET', 'PUT', 'DELETE'])
def snippet_detail(request, pk, format=None):
    """
    检索，更新或删除代码段。
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return Response(status=status.HTTP_404_NOT_FOUND)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    elif request.method == 'PUT':
        # data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    elif request.method == 'DELETE':
        Snippet.delete()
        return HttpResponse(status=status.HTTP_204_NO_CONTENT)

           

• 现在的代码看起来更加简洁一点，其中还使用了命名的状态码，使响应的意义更加明显
• 增加了

  format

  参数用于指定请求的类型，默认为

  None

  ，没有指定的时候，会返回它默认的视图
• 我们不再明确地将我们的请求或响应绑定到给定的内容类型，

  request.data

  可以处理

  json

  请求，也可以处理其他格式的请求
• 再修改

  snippets

  目录下的

  urls.py

  文件

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns  # 添加
from snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>', views.snippet_detail),
]

urlpatterns = format_suffix_patterns(urlpatterns)   # 添加
           

• 进行测试：

http http://127.0.0.1:8000/snippets.json  # 返回 JSON 格式
http http://127.0.0.1:8000/snippets.api   # 返回 HTML API 格式
           

使用APIView编写视图

• APIView是基于类的API视图
• 修改

  views.py

  文件

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class SnippetList(APIView):
    """
    列出所有代码段，或创建新代码段。
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(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 SnippetDetail(APIView):
    """
    检索，更新或删除代码段。
    """
    def get_object(self, pk):
        try:
            return Snippet.objects.get(pk=pk)
        except Snippet.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet, 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, format=None):
        snippet = self.get_object(pk)
        snippet.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)
        
           

• 这与基于函数方法的API视图还是很相似
• 接下来修改

  snippets

  目录下的

  urls.py

  文件

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    path('snippets/', views.SnippetList.as_view()),
    path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)
           

• 测试方法与

  @api_view

  一样， 效果也是一致的。