教程2--请求和响应

来源:互联网 发布:淘宝皮草品牌 编辑:程序博客网 时间:2024/04/30 03:03

教程2–请求和响应

tips:本文纯属瞎翻译,还加了一点自己的理解。大家参考就好。

这里说的请求和响应是指扩展了Django的REST框架的请求和响应。

请求对象

Request对象拓展了HttpRequest对象。并且提供了更加灵活的请求解析。Request的核心功能是request.data,这个和request.POST比较类似,但是POST本身只能用来解析表单数据。

request.POST  # Only handles form data.  Only works for 'POST' method.request.data  # Handles arbitrary data.  Works for 'POST', 'PUT' and 'PATCH' methods.

响应对象

Response继承了TemplateResponse。它使用一种叫做内容协商的工具来决定如何渲染数据。

状态码

纯数字的状态码阅读性很差,所以REST框架提供了一些可读性较高的状态码表示,例如:在status模块中的HTTP_400_BAD_REQUEST

包装API views

REST框架提供了两种包装方式:

  1. 使用@api_view装饰器——适用于基于函数的视图。
  2. 使用APIView类——适用于基于类的视图。

包装API views的主要作用是将Request替换成REST框架的请求对象,并且为Response添加上下文信息,这个上下文信息中就包含着内容协商,以此,Response可以渲染数据。
包装类还提供了一些很方便的用途,例如自动返回错误状态码等。

开工!

上面说了一大堆理论,下面开始用一下试试看。

因为我们现在直接使用REST框架的Response了,所以不需要再用JSONResponse了,把它干掉!

# coding=utf-8from rest_framework import statusfrom rest_framework.decorators import api_viewfrom rest_framework.parsers import JSONParserfrom rest_framework.response import Responsefrom snippets.models import Snippetfrom snippets.serializers import SnippetSerializer@api_view(["GET", "POST"])def snippet_list(request):    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=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):    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)        # 如果需要更新(调用update方法),则需要传入一个已经存在的模型实例!        serializer = SnippetSerializer(snippet, data=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 Response(status=status.HTTP_204_NO_CONTENT)

现在的代码看起来更简洁了一些,而且可读性也很好。
通过使用REST的Response我们可以将响应渲染成任意格式。

为URL添加可选的格式后缀

为了证明现在的返回格式可以是灵活多变的了,我们来看下这个例子。首先,要为视图函数添加参数format

def snippet_list(request, format=None):    ...def snippet_detail(request, pk, format=None):    ...

然后修改urls.py

from django.conf.urls import urlfrom rest_framework.urlpatterns import format_suffix_patternsfrom snippets import viewsurlpatterns = [    url(r'^snippets/$', views.snippet_list),    url(r'^snippets/(?P<pk>[0-9]+)$', views.snippet_detail),]urlpatterns = format_suffix_patterns(urlpatterns)

我们可以使用Httpie进行测试

http http://127.0.0.1:8000/snippets/ Accept:application/json  # Request JSONhttp http://127.0.0.1:8000/snippets/ Accept:text/html         # Request HTMLhttp http://127.0.0.1:8000/snippets.json  # JSON suffixhttp http://127.0.0.1:8000/snippets.api   # Browsable API suffix

对浏览器的支持

由于REST框架的响应值形式是根据请求的content-type来的,浏览器默认的请求就是html,所以返回的都是html类型的数据。这其实是一个巨大的提高,这样我们开发和调试接口更方便了,而且那些不懂技术但是却要检查我们API正确性的人也能看得懂了。

下一章

下一章我们来讲基于类的视图,一起来看看如何使用通用视图来缩减代码量。

0 0
原创粉丝点击