zoukankan      html  css  js  c++  java
  • Django REST FrameWork中文教程2:请求和响应

    从这一点开始,我们将真正开始覆盖REST框架的核心。我们来介绍几个基本的构建块。

    请求对象
    REST框架引入了Request扩展常规的对象HttpRequest,并提供更灵活的请求解析。Request对象的核心功能是request.data属性,这与request.POST使用Web API 相似但更有用。

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

      

    响应对象
    REST框架还引入了一个Response对象,它是一种类型的对象,它TemplateResponse采用未呈现的内容,并使用内容协商来确定正确的内容类型以返回给客户端。

    return Response(data)  # Renders to content type as requested by the client.
    

      

    状态码
    在您的视图中使用数字HTTP状态代码并不总是用于明显的阅读,如果错误代码错误,很容易就不会注意到。REST框架为每一个状态码更明确的标识符,如HTTP_400_BAD_REQUEST所述的status模块。相对于使用数字标识符更好。

    包装API视图
    REST框架提供了两个可用于编写API视图的包装器。

    @api_view用于使用基于功能的视图的装饰器。

    该APIView班与基于类的视图工作。

    这些包装器提供了一些功能,例如确保您Request在视图中接收实例,并将上下文添加到Response对象,以便可以执行内容协商。

    包装器还提供405 Method Not Allowed适当的返回响应等行为,以及处理使用格式不正确的输入ParseError访问时发生的任何异常request.data。

    把它拉在一起
    好的,让我们开始使用这些新的组件来写几个视图。

    我们不再需要我们的JSONResponse课views.py,所以继续删除。一旦完成,我们可以稍微开始重构我们的观点。

    from rest_framework import status
    from rest_framework.decorators import api_view
    from rest_framework.response import Response
    from snippets.models import Snippet
    from snippets.serializers import SnippetSerializer
    
    
    @api_view(['GET', 'POST'])
    def snippet_list(request):
        """
        显示snippets所有数据,后者创建一个新的snippet
        """
        if request.method == 'GET':
            snippets = Snippet.objects.all()
            serializer = SnippetSerializer(snippets, many=True)
            return Response(serializer.data)
    
        elif request.method == 'POST':
            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)
    

      

    我们的实例视图比以前的例子有所改进。这有点简明扼要,现在的代码与我们使用Forms API非常相似。我们还使用命名状态代码,这使得响应意义更加明显。

    以下是views.py模块中单个代码段的视图。

    @api_view(['GET', 'PUT', 'DELETE'])
    def snippet_detail(request, pk):
        """
        snippet的查、更新、删除
        """
        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':
            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 Response(status=status.HTTP_204_NO_CONTENT)
    

      

    这应该都是非常熟悉的 - 它与使用常规Django视图没有什么不同。

    请注意,我们不再明确地将我们的请求或响应明确绑定到给定的内容类型。 request.data可以处理传入的json请求,但它也可以处理其他格式。类似地,我们使用数据返回响应对象,但允许REST框架将响应呈现给正确的内容类型。

    向我们的网址添加可选的格式后缀
    为了充分利用我们的响应不再单一的内容类型,我们可以为API端点添加对格式后缀的支持。使用格式后缀给我们明确指定给定格式的URL,这意味着我们的API将能够处理诸如http://example.com/api/items/...之类的 URL 。

    首先format在两个视图中添加一个关键字参数,就像这样。

    def snippet_list(request, format=None):
    

      

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

      

    现在urls.py稍稍更新文件,format_suffix_patterns除了现有的URL之外还附加一组。

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

      

    我们不一定需要添加这些额外的url模式,但它给了我们一个简单,干净的方式来引用特定的格式。

    怎么看?
    从命令行开始测试API,就像我们在第1部分中所做的那样。一切工作都非常相似,尽管如果发送无效请求,我们有更好的错误处理。

    我们可以像以前一样获取所有片段的列表。

    http http://127.0.0.1:8000/snippets/
    
    HTTP/1.1 200 OK
    ...
    [
      {
        "id": 1,
        "title": "",
        "code": "foo = "bar"
    ",
        "linenos": false,
        "language": "python",
        "style": "friendly"
      },
      {
        "id": 2,
        "title": "",
        "code": "print "hello, world"
    ",
        "linenos": false,
        "language": "python",
        "style": "friendly"
      }
    ]
    

      

    我们可以通过使用Accept头来控制回复的格式:

    http http://127.0.0.1:8000/snippets/ Accept:application/json  # Request JSON
    
    http http://127.0.0.1:8000/snippets/ Accept:text/html         # Request HTML
    

      

    或通过附加格式后缀:

    http http://127.0.0.1:8000/snippets.json  # JSON suffixhttp 
    http://127.0.0.1:8000/snippets.api   # Browsable API suffix
    

      

    类似地,我们可以使用Content-Type头来控制我们发送的请求的格式。

    # POST using form data
    http --form POST http://127.0.0.1:8000/snippets/ code="print 123"
    
    {
      "id": 3,
      "title": "",
      "code": "print 123",
      "linenos": false,
      "language": "python",
      "style": "friendly"
    }
    
    # POST using JSON
    http --json POST http://127.0.0.1:8000/snippets/ code="print 456"
    
    {
        "id": 4,
        "title": "",
        "code": "print 456",
        "linenos": false,
        "language": "python",
        "style": "friendly"
    }
    

      

    如果您--debug向上述http请求添加切换器,则可以在请求标头中查看请求类型。

    现在,在Web浏览器中打开API,访问http://127.0.0.1:8000/snippets/

    浏览功能
    由于API根据客户端请求选择响应的内容类型,因此默认情况下,当Web浏览器请求该资源时,它将返回资源的HTML格式表示。这允许API返回完全可浏览网页的HTML表示。

    拥有可浏览网页的API是一个巨大的可用性胜利,并使开发和使用您的API更容易。它也大大降低了其他开发人员要检查和使用API的障碍。

    有关可浏览的API功能以及如何自定义API的更多信息,请参阅可浏览的api主题。

    下一步是什么?
    在第3部分的教程中,我们将开始使用基于类的视图,并查看通用视图如何减少需要编写的代码量。

    Django REST FrameWork中文文档目录:

    Django REST FrameWork 中文教程1:序列化

    Django REST FrameWork 中文教程2:请求和响应

    Django REST FrameWork 中文教程3:基于类的视图

    Django REST FrameWork 中文教程4:验证和权限

    Django REST FrameWork 中文教程5:关系和超链接API

    Django REST FrameWork 中文教程6: ViewSets&Routers

    Django REST FrameWork 中文教程7:模式和客户端库

  • 相关阅读:
    网络运维架构
    Q in Q
    光纤/光模块的多模和单模
    Cisco VTP
    Cisco NTP配置
    惠普/aruba交换机
    【转】交换机背板带宽
    接入交换机下所有服务器不定时丢包
    windows 2012安装不了KB2919355
    Cisco交换机密码策略设置
  • 原文地址:https://www.cnblogs.com/chenxinming-top/p/7655786.html
Copyright © 2011-2022 走看看