请求和响应

Django REST framework 处理请求和响应有以下几个关键点。

1. 请求对象（Request objects）

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

request.POST  # 只处理表单数据  只适用于'POST'方法
request.data  # 处理任意数据  适用于'POST'，'PUT'和'PATCH'方法

2. 响应对象（Response objects）

REST 框架还引入了一个 Response 对象，这是一种获取未渲染（unrendered）内容的 TemplateResponse 类型，并使用内容协商来确定返回给客户端的正确内容类型。

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

3. 状态码（Status codes）

在你的视图（views）中使用纯数字的 HTTP 状态码并不总是那么容易被理解。而且如果错误代码出错，很容易被忽略。

REST 框架为 status 模块中的每个状态代码（如 HTTP_400_BAD_REQUEST）提供更明确的标识符。使用它们来代替纯数字的 HTTP 状态码是个很好的主意。

4. 包装（wrapping）API 视图

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

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

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

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

组合在一起

好的，我们开始把上面几点组合。

现在 views.py 中不再需要 JSONResponse 类了，所以把它删除掉。删除之后，我们就可以开始重构我们的视图了。

from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response

from myApp.models import Book
from myApp.serializers import BookSerializer


@api_view(['GET'])
def book_list(request):
    all_books = Book.objects.all()
    serializer = BookSerializer(all_books, many=True)
    return Response(serializer.data)
    

@api_view(['POST'])
def add_book(request):
    serializer = BookSerializer(data=request.data)
    if serializer.is_valid():
        serializer.save()
        return Response(serializer.data, status=status.HTTP_201_CREATED)
    else:
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

我们的实例视图比前面的示例有所改进。它稍微简洁一点，现在的代码与我们使用 Forms 时非常相似。我们还使用了命名状态代码，这使得响应意义更加明显。

给网址添加可选的格式后缀

使用该功能我们能得到诸如 http://example.com/api/book_list.json 之类的 URL。

首先在视图中添加一个 format 关键字参数：

def book_list(request, format=None):
    ......

现在更新 urls.py，给现有的 URL 后面添加一组 format_suffix_patterns：

......
from rest_framework.urlpatterns import format_suffix_patterns

urlpatterns = [
    url(r'^admin/', admin.site.urls),

    url(r'^api/book_list/', book_list, name='api_book_list'),
    url(r'^api/add_book/', add_book, name='api_add_book'),

    url(r'^index/', index),
]

urlpatterns = format_suffix_patterns(urlpatterns)

我们就可以这样获取 API 的 json：http://127.0.0.1:8000/api/book_list.json

最后编辑于：2018.04.15 17:52:23