2-请求和答复-Django REST框架

教程2：请求和响应

从现在开始，我们将真正开始讨论REST框架的核心。让我们介绍几个基本的构建块。

请求对象

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

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)

与前面的示例相比，我们的实例视图是一个改进。它更简洁一些，现在的代码感觉非常类似于如果我们使用FormsAPI。我们还使用了命名状态代码，这使得响应的含义更加明显。

下面是单个代码段的视图，位于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将能够处理URL，例如http://example.com/api/items/4.json.

首先，添加一个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模式，但它为我们提供了一种简单、干净的方法来引用特定的格式。

看上去怎么样？

继续从命令行测试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在上面的请求中，您将能够在请求头中看到请求类型。

现在去打开web浏览器中的api，访问http://127.0.0.1:8000/snippets/.

褐变

因为API基于客户端请求选择响应的内容类型，默认情况下，当Web浏览器请求该资源时，它将返回该资源的HTML格式表示形式。这允许API返回一个完全可浏览的HTML表示。

拥有一个Web可浏览的API是一个巨大的可用性胜利，并使您的API的开发和使用更加容易。它还大大降低了其他希望检查和使用API的开发人员进入的门槛。

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

接下来是什么？

在……里面教程第3部分，我们将开始使用基于类的视图，并查看泛型视图如何减少我们需要编写的代码量。