教程 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 框架为每个状态代码提供了更明确的标识符，例如 status 模块中的 HTTP_400_BAD_REQUEST。最好始终使用这些标识符，而不是使用数字标识符。

包装 API 视图

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

@api_view 装饰器，用于处理基于函数的视图。
APIView 类，用于处理基于类的视图。

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

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

将所有内容整合在一起

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

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 端点添加对格式后缀的支持。使用格式后缀为我们提供了明确引用给定格式的 URL，这意味着我们的 API 将能够处理诸如 http://example.com/api/items/4.json 的 URL。

首先，像这样为两个视图添加一个 format 关键字参数。

def snippet_list(request, format=None):

和

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

现在稍微更新一下 snippets/urls.py 文件，除了现有的 URL 之外，还追加一组 format_suffix_patterns。

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"
}

如果你在上面的 http 请求中添加一个 --debug 开关，你将能够在请求头中看到请求类型。

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

可浏览性

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

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

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

接下来是什么？

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