Django rest框架：教程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视图的包装器。

1.@api_view用于处理基于函数的视图的装饰器。 2.该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):
    """
    List all code snippets, or create a new 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):
    """
    Retrieve, update or delete a code 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框架将响应呈现给我们正确的内容类型。

在我们的URL中添加可选的格式后缀

为了利用我们的响应不再硬连接到单个内容类型这一事实，我们将API格式后缀添加到API端点。使用格式后缀为我们提供了明确引用给定格式的URL，这意味着我们的API将能够处理诸如http://example.com/api/items/4.json之类的 URL 。

首先format在两个视图中添加关键字参数，如下所示。

def snippet_list(request, format=None):

and

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

现在snippets/urls.py稍微更新文件，以附加format_suffix_patterns现有URL之外的一组。

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)

我们不一定需要添加这些额外的url模式，但它为我们提供了一种简单，干净的方式来引用特定的格式。

怎么样？

继续从命令行测试API，就像我们在教程第1部分中所做的那样。一切都工作得非常相似，尽管如果我们发送无效请求，我们会有一些更好的错误处理。

我们可以像以前一样获得所有代码段的列表。

http http://127.0.0.1:8000/snippets/

HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print \"hello, world\"\n",
    "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 suffix
http 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上面的请求中添加了一个开关，您将能够在请求标头中看到请求类型。

现在，通过访问http://127.0.0.1:8000/snippets/，在Web浏览器中打开API 。

浏览功能

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

拥有可浏览网页的API是一项巨大的可用性，并且使开发和使用API​​变得更加容易。它还大大降低了其他想要检查和使用API​​的开发人员的入门门槛。

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

更多Django教程

学习更多Django教程