Django REST framework-API指南03-Class-based Views 原创翻译

python技术交流群332680349，资源分享，技术交流。

01-基于类的视图

Django的基于类的视图和老式的视图是不同的。
出自 Reinout van Rees

REST框架提供了一个APIView类，它继承Django的View类。

APIView类与普通View类有以下不同：

• 传递给处理程序方法的请求将是REST框架的Request实例，而不是Django的HttpRequest实例。
• 处理器方法可能返回REST框架Response，而不是Django HttpResponse。该视图将管理内容协商，并根据响应设置正确的渲染器。
• 任何除了APIException例外，都将被捕获并被调解为适当的响应。
• 传入请求将被认证，并且在将请求发送到处理程序方法之前将运行适当的权限和/或访问数量限制的检查。
  使用APIView类与使用常规View类一样，像往常一样，将传入的请求调度到适当的处理程序方法，例如.get()或.post()。另外，可以在控制API策略的各个方面的类上设置许多属性。

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions
from django.contrib.auth.models import User

class ListUsers(APIView):
    """
    View to list all users in the system.

    * Requires token authentication.
    * Only admin users are able to access this view.
    """
    authentication_classes = (authentication.TokenAuthentication,)
    permission_classes = (permissions.IsAdminUser,)

    def get(self, request, format=None):
        """
        Return a list of all users.
        """
        usernames = [user.username for user in User.objects.all()]
        return Response(usernames)

API策略的属性

以下属性控制API视图的增加或删除的属性。
- .renderer_classes
- .parser_classes
- .authentication_classes
- .throttle_classes
- .permission_classes
- .content_negotiation_class

API策略的实例化方法

REST框架使用以下方法实例化各种可增删API策略。通常不需要重写这些方法。

• .get_renderers(self)
• .get_parsers(self)
• .get_authenticators(self)
• .get_throttles(self)
• .get_permissions(self)
• .get_content_negotiator(self)
• .get_exception_handler(self)

API策略的执行方法

调度到处理方法之前调用以下方法。

• .check_permissions（self，request）
• .check_throttles（self，request）
• .perform_content_negotiation（self，request，force = False）

调度方法

以下方法直接由视图的.dispatch()方法调用。这些执行需要之前或之后调用处理方法，.例如get()，.post()，put()，patch()和.delete()。

.initial（self，request，* args， kwargs）**

执行的任何操作前，需要调用的处理程序方法。此方法用于执行权限和限制访问数量，并执行内容协商。
通常不需要重写此方法。

.handle_exception（self，exc）

处理程序方法抛出的任何异常都将传递给此方法，该方法返回一个Response实例，或重新引发异常。

默认实现处理任何rest_framework.exceptions.APIException子类，以及Django Http404和PermissionDenied异常，并返回适当的错误响应。

如果您需要自定义API返回的错误响应，则应该对此方法进行子类化。

.initialize_request（self，request，* args， kwargs）**

确保传递给处理方法的请求对象是一个Request实例，而不是通常的Django HttpRequest。

通常不需要重写此方法。

.finalize_response（self，request，response，* args， kwargs）**

确保从处理程序方法返回的任何Response象对象将被呈现为内容协商确定的正确内容类型。
通常不需要重写此方法。

02-基于函数的视图

说[基于类的视图]永远是高级的解决方案是一个错误。尼克·考格兰

REST框架还允许您使用基于函数的视图。它提供了一组简单的装饰器，可以包装基于函数的视图，以确保它们接收到一个Request实例（而不是通常的Django HttpRequest），并允许它们返回Response（而不是Django HttpResponse），并允许您配置请求的处理方式。

@api_view()

签名属性： @api_view(http_method_names=[‘GET’], exclude_from_schema=False)

这个函数的核心是api_view装饰器，它将列出您的视图应该响应的HTTP方法。例如，这是你如何编写一个非常简单的视图，只需手动返回一些数据：

from rest_framework.decorators import api_view

@api_view()
def hello_world(request):
    return Response({"message": "Hello, world!"})

此视图将使用设置中指定的默认渲染器，解析器，验证类等详细设置。

默认情况下只GET接受方法。其他方法将以“405方法不允许”作出响应。要更改此行为，请指定视图允许的方法，如下所示：

@api_view(['GET', 'POST'])
def hello_world(request):
    if request.method == 'POST':
        return Response({"message": "Got some data!", "data": request.data})
    return Response({"message": "Hello, world!"})

您还可以使用exclude_from_schema以下参数将API视图标记为从任何自动生成的模式中省略：

@api_view(['GET'], exclude_from_schema=True)
def api_docs(request):

...

API策略的装饰器

要更改默认设置，REST框架提供了一组可以添加到您的视图中的其他装饰器。这些一定要在@api_view装饰之后设置。例如，要创建一个使用节流器确保每天只能由特定用户调用一次的视图，请使用@throttle_classes装饰器，传递油门类别列表：

from rest_framework.decorators import api_view, throttle_classes
from rest_framework.throttling import UserRateThrottle

class OncePerDayUserThrottle(UserRateThrottle):
        rate = '1/day'

@api_view(['GET'])
@throttle_classes([OncePerDayUserThrottle])
def view(request):
    return Response({"message": "Hello for today! See you tomorrow!"})

这些装饰器对应于APIView上面描述的在子类上设置的属性。

可用的装饰是：

1. @renderer_classes(…)
2. @parser_classes(…)
3. @authentication_classes(…)
4. @throttle_classes(…)
5. @permission_classes(…)
   这些装饰器中的每一个都采用单一参数，它必须是列表或元组元素。