基于类的视图

APIView类与Django View类的区别

  • 被传入到处理方法的请求不会是Django的HttpRequest类的实例,而是REST framework的Request类的实例。
  • 处理方法可以返回REST framework的Response,而不是Django的HttpRespnse。视图会管理内容协议,给响应设置正确的渲染器。
  • 任何APIException异常都会被捕捉,并且传递给合适的响应。
  • 传入的请求都将被认证,并且在将请求分配给处理程序方法之前将运行适当的权限和(或)限流检测。

使用APIView类与使用常规的View类几乎是一样的,像往常一样,传入的请求被分派到适当的处理程序方法,如.get().post()。另外,可以在控制API策略的各个方面的类上设置多个属性。

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions


class ListUsers(APIView):
"""
所有用户视图,需要token认证,只有管理员用户才可以访问这个视图。
"""

    authentication_classes = (authentication.TokenAuthentication,)
    permission_classes = (permission.IsAdminUser,)

    def get(self, request, format=None):
        """
        返回所有用户的列表
        """
        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 framework使用一下方法来实例化各种可插入API策略。通常情况下不需要重写这些方法。

  • .get_renderers(slef)
  • .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(selfm request)
  • .perform_content_negotiation(self, request, force=Flase)

调度方法

以下方法由视图的.dispatch()方法直接调用。它们执行调用处理程序方法之前或之后的任何操作,例如.get().post().put().patch().delete()

  • .initial(self, request, *args, **kwargs)
    执行在调用处理方法之前需要执行的任何操作。该方法用于强制执行权限和限流,并执行内容协商,通常不需要重写此方法。
  • .handle_exception(self, exc)
    处理程序方法抛出的任何异常都将传递给此方法,该方法要么返回Response实例,要么重新引发异常。
    默认实现处理rest_framework.exceptions.APIException的任何子类,以及Django的Http404和OernussuibDenied异常,并返回相应的错误相应。
    如果需要自定义API返回的错误相应,应子类化此方法。
  • .initialize_request(self, request, *args, **kwargs)
    确保传递给处理程序方法的请求对象是Request的一个实例,而不是通常的Django HTTPResponse。
    通常不需要重写此方法。
  • .finalize_repsonse(self, request, response, *args, **kwargs)
    确保从处理程序方法返回的任何Response对象都被渲染成正确的内容类型,这是由内容协商决定。
    通常不需要重写此方法。

基于函数的视图

REST framework同样也允许使用常规的基于函数的视图。提供了一套简单的装饰器来包装基与函数的视图,以确保它们接受Request实例而不是通常的Django HttpRequest,并允许它们返回Response实例而不是Django HttpReponse,同时允许配置该请求的处理方式。

api_view

语法:@api_view(http_method_names=["GET"])
这个功能的核心是api_view装饰器,它接受视图应该相应的HTTP方法列表。

from rest_framework.decorators import api_view


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

该视图将使用设置中指定的默认渲染器、解释器、身份验证器等。
默认情况下,只接受GET方法,其他方法将返回相应405 Method Not Allowed

API策略装饰器

为了覆盖默认设置,REST framework提供了一系列可以添加到视图中的附加装饰器。这些必须在@api_view装饰器之后。例如,要创建一个使用限流来确定它每天只能由听定用户调用一次的视图,需要使用@throttle_classes装饰器,传递一个限流类列表:

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


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


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

这些装饰器对应于APIView子类中设置的属性。
可用的装饰器有:

视图模式装饰器

要覆盖基于函数的视图的默认模式生成,可用是用@schema装饰器。这必须在@api_view装饰器之后。

from rest_framework.decorators import api_view, schema
from rest_framework.shcemas import AutoSchema


class CustomAutoSchema(AutoSchema):
    def get_link(self, path, method, base_url):
        # 在此重写视图


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

示例中的装饰器接受一个AutoSchema实例,一个Autoschema子类实例或ManuaSchema实例。为了从模式生成中排除视图,可以传递None。

0条评论

相关推荐

django教程

r

Django 2019-05-20 10:53:53

Celery

celery学习资料

Django 2019-05-25 18:41:55

django教程入门

适合django新人使用的学习手册

Django 2019-07-01 14:28:04

django实用资料

django项目从0到1自己总结的实用的资料,大部分常用的功能这里都有

Django 2019-05-08 18:21:34