02-请求与响应

此文档为官方文档的翻译，原文地址：https://www.django-rest-framework.org/tutorial/2-requests-and-responses/

介绍

从现在开始，我们将真正开始介绍 REST 框架的核心，让我们先介绍几个必不可少的构件。

Request对象

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

  1. request.POST  # 只处理表单数据。只适用于“ POST”方法。
  2. request.data  # 处理任意数据。适用于“ POST”、“ PUT”和“ PATCH”方法。

Response对象

REST框架还引入了一个Response对象，这是一种TemplateResponse类型。不像Django自带的各式各样的response，它就这一个，没有兄弟姐妹的独生子，这在返回形式上大大统一了。最牛逼的一点，它能根据客户端的请求呈现内容的形式。它接受的是未渲染的内容，并使用内容协商来确定要返回给客户端的正确内容类型。

  1. return Response(data)  # 根据客户端的请求呈现内容类型。

状态码

在视图中使用数字HTTP状态码并不总是很明显，如果出现错误代码，很容易被忽略。REST框架为每个状态代码提供了更显式的标识符，比如status模块中的HTTP_400_BAD_REQUEST。这样可以让状态码的含义一目了然，再也不会因记错了状态码而导致代码错误了！

封装API视图

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

  • @api_view：视图函数装饰器。
  • APIView类 ：用于类视图。

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

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

综合应用

好的，让我们开始使用这些新组件来稍微重构我们的视图。

  1. from rest_framework import status
  2. from rest_framework.decorators import api_view
  3. from rest_framework.response import Response
  4. from snippets.models import Snippet
  5. from snippets.serializers import SnippetSerializer
  8. @api_view(['GET', 'POST'])
  9. def snippet_list(request):
  10.     """
  11.     列出所有Snippet，或者创建一个新的Snippet。
  12.     """
  13.     if request.method == 'GET':
  14.         snippets = Snippet.objects.all()
  15.         serializer = SnippetSerializer(snippets, many=True)
  16.         return Response(serializer.data)
  18.     elif request.method == 'POST':
  19.         serializer = SnippetSerializer(data=request.data)
  20.         if serializer.is_valid():
  21.             serializer.save()
  22.             return Response(serializer.data, status=status.HTTP_201_CREATED)
  23.         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
  26. @api_view(['GET', 'PUT', 'DELETE'])
  27. def snippet_detail(request, pk):
  28.     """
  29.     检索、更新或删除Snippet
  30.     """
  31.     try:
  32.         snippet = Snippet.objects.get(pk=pk)
  33.     except Snippet.DoesNotExist:
  34.         return Response(status=status.HTTP_404_NOT_FOUND)
  36.     if request.method == 'GET':
  37.         serializer = SnippetSerializer(snippet)
  38.         return Response(serializer.data)
  40.     elif request.method == 'PUT':
  41.         serializer = SnippetSerializer(snippet, data=request.data)
  42.         if serializer.is_valid():
  43.             serializer.save()
  44.             return Response(serializer.data)
  45.         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
  47.     elif request.method == 'DELETE':
  48.         snippet.delete()
  49.         return Response(status=status.HTTP_204_NO_CONTENT)

重构之后，我们的代码更简洁了，现在的代码感觉与Django的Forms API时非常相似。我们还使用了命名状态码，这使得响应的含义更加明显。

这些操作你应该很眼熟——它与使用常规Django视图没有太大区别。

注意，我们不再显式地将请求或响应绑定到给定的内容类型。

  • 一方面：request.data可以处理传入的json请求，但它也可以处理其他格式。
  • 另一方面：我们返回带有数据的响应对象，但允许REST框架将响应呈现为正确的内容类型。

上面的高亮内容翻译成人话：我们的接口越来越统一。

向 url 添加可选的格式后缀

为了利用我们的响应不再硬连接到单一内容类型这一事实，让我们向API端点添加对格式后缀的支持。使用格式后缀为我们提供了显式地引用给定格式的url，这意味着我们的API将能够处理像http://example.com/api/items/4.json这样的url。

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

  1. def snippet_list(request, format=None):
  2.     ...
  5. def snippet_detail(request, pk, format=None):
  6.     ...

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

  1. from django.urls import path
  2. from rest_framework.urlpatterns import format_suffix_patterns
  3. from snippets import views
  5. urlpatterns = [
  6.     path('snippets/', views.snippet_list),
  7.     path('snippets/<int:pk>', views.snippet_detail),
  8. ]
  10. urlpatterns = format_suffix_patterns(urlpatterns)

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

测试成果

我们可以像以前一样得到所有Snippet的列表。

  1. http http://127.0.0.1:8000/snippets/
  3. HTTP/1.1 200 OK
  4. ...
  5. [
  6.     {
  7.         "code": "foo = \"bar\"\n",
  8.         "id": 1,
  9.         "language": "python",
  10.         "linenos": false,
  11.         "style": "friendly",
  12.         "title": ""
  13.     },
  14.     {
  15.         "code": "print(\"hello, world\")\n",
  16.         "id": 2,
  17.         "language": "python",
  18.         "linenos": false,
  19.         "style": "friendly",
  20.         "title": ""
  21.     },
  22.     {
  23.         "code": "print(\"hello, world\")",
  24.         "id": 3,
  25.         "language": "python",
  26.         "linenos": false,
  27.         "style": "friendly",
  28.         "title": ""
  29.     }
  30. ]

我们可以通过使用Accept头文件来控制返回的响应的格式:

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

或者添加一个格式后缀：

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

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

  1. # 使用表单数据 POST
  2. http --form POST http://127.0.0.1:8000/snippets/ code="print(123)"
  4. {
  5.     "code": "print(123)",
  6.     "id": 4,
  7.     "language": "python",
  8.     "linenos": false,
  9.     "style": "friendly",
  10.     "title": ""
  11. }
  14. # 使用 JSON 的 POST
  15. http --json POST http://127.0.0.1:8000/snippets/ code="print(456)"
  17. {
  18.     "code": "print(456)",
  19.     "id": 5,
  20.     "language": "python",
  21.     "linenos": false,
  22.     "style": "friendly",
  23.     "title": ""
  24. }

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

可浏览性

因为API根据客户端请求选择响应的内容类型，所以当web浏览器请求资源时，默认情况下它将返回资源的html格式表示。这允许API返回一个完全可在网络上浏览的HTML表示。

拥有一个web可浏览的API是一个巨大的可用性胜利，并且使开发和使用你的API更容易。它还极大地降低了其他开发人员想要检查和使用您的API的门槛。

有关可浏览的 API 特性以及如何定制它的更多信息，请参见可浏览的 API主题。

下一步做什么

在教程的第3部分中，我们将开始使用基于类的视图，并了解通用视图如何减少我们需要编写的代码量。