第03篇 请求和响应

教程 2：请求和响应

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

请求对象

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

包装 API 视图

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

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

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

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

将它们拉在一起

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

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稍微更新文件，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 模式，但它为我们提供了一种简单、干净的方式来引用特定格式。

它看起来怎么样？

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

和以前一样，我们可以获得所有片段的列表。

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 返回完全可通过 Web 浏览的 HTML 表示。

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

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

下一步是什么？

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

posted @ 2022-04-01 09:59  李延召的Blog  阅读(39)  评论(0)    收藏  举报