教程2-请求和响应对象

请求和响应对象

目录

• 请求和响应对象
  • 请求对象
  • 响应对象
  • 状态码
  • 包装API 视图
  • 把一切都集中起来
  • 在我们的URL中添加可选的格式后缀
  • 看起来怎么样?
  • 可浏览性
  • 下一章干嘛？

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

请求对象

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

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

响应对象

REST框架还引入了Response对象。 这是TemplateResponse的一种类型，它接收未呈现的内容并使用内容协商来确定要返回给客户端的正确内容类型。

return Response(data) # 渲染为客户端请求的内容类型。

状态码

在视图中使用数字HTTP状态代码并不总是很容易阅读.而且很容易不知道您是否输入了错误的错误代码。REST框架为每个状态码提供了更明确的标识符.例如status模块中的HTTP_400_BAD_REQUEST。最好始终使用它们而不是使用数字标识符。

包装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):
    """
    列出所有代码段，或创建一个新的代码段。
    """
    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):
    """
    检索，更新或删除代码段。
    """
    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。

首先，向两个视图添加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"
",
    "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  # 请求 JSON
http http://127.0.0.1:8000/snippets/ Accept:text/html         # 请求 HTML

或通过添加格式后缀：

http http://127.0.0.1:8000/snippets.json  # JSON 后缀
http http://127.0.0.1:8000/snippets.api   # 可浏览的API后缀

同样，我们可以使用Content-Type标头来控制发送的请求的格式。

# POST 使用表单数据
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 使用 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开关, 您将能够在请求头中看到请求类型。现在在web浏览器中打开API 通过访问http://127.0.0.1:8000/snippets/。

可浏览性

因为API根据客户端请求选择响应的内容类型, 它会， 通过默认，Web浏览器请求资源时，返回该资源的HTML格式表示。这允许API返回完全可在网络上浏览的HTML表示形式。拥有可浏览网络的API是巨大的可用性， 并简化了API的开发和使用。它也大大降低了其他想要检查和使用您的API的开发人员的进入门槛。

请参阅browable api主题，以获取有关可浏览的API功能以及如何对其进行自定义的更多信息。

下一章干嘛？

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