API 指南(3-1):基于类的视图(APIView)

官方文档原文

基于类的视图

REST framework 提供了一个 APIView 类,它继承于 Django 的 View 类。

APIView 类与 View 类有所不同:

  • 传递给处理方法的 request 对象是 REST framework 的 Request 实例,而不是 Django 的 HttpRequest 实例。

  • 处理方法可能返回 REST framework 的 Response,而不是 Django 的 HttpResponse 。该视图将管理内容协商,并在响应中设置正确的渲染器。

  • 任何 APIException 异常都会被捕获并进行适当的响应。

  • 传入的请求会进行认证,在请求分派给处理方法之前将进行适当的权限检查(允许或限制)。

像往常一样,使用 API​​View 类与使用常规 View 类非常相似,传入的请求被分派到适当的处理方法,如 .get().post()。此外,可以在类上设置许多属性(AOP)。

一个例子:

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):
    """
    列出系统中的所有用户

    * 需要 token 认证。
    * 只有 admin 用户才能访问此视图。
    """
    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)

上例用到的 authentication_classespermission_classes 属于 API 策略属性(policy attributes)。




API 策略属性(policy attributes)

以下属性用于增加扩展视图的功能,AOP:

.renderer_classes
设置渲染器

.parser_classes
设置解析器

.authentication_classes
设置认证器

.throttle_classes
设置访问频率控制器

.permission_classes
设置权限验证器

.content_negotiation_class




API 策略实例方法(policy instantiation methods)

以下策略实例方法通常不需要我们重写。

.get_renderers(self)

.get_parsers(self)

.get_authenticators(self)

.get_throttles(self)

.get_permissions(self)

.get_content_negotiator(self)

.get_exception_handler(self)




API 策略实现方法(policy implementation methods)

在分派到处理方法之前会调用以下方法。

.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 对象将被呈现为正确的内容类型,这由内容协商确定。

通常不需要重写此方法。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容