Request和Response

一、request

REST framework的 Request 扩展了标准的 HttpRequest,添加支持了REST framework灵活的request解析和request认证


1.Request parsing


REST framework的Request对象提供了灵活的request解析,允许你用JSON数据或者其他的媒体类型处理request,和通常处理表单数据一样 。

.date

request.data 返回request body的解析后的内容,这和标准的request.POST和request.FILES属性相似,除了以下这些:

  • 它包含所有的解析的内容,包括file和non-file输入。
  • 他提供对HTTP方法的内容的解析不止于POST,这意味着你可以存取基于PUT和PATCH的内容的request。
  • 相对于只支持表单数据,他提供了对REST framework灵活的request解析,例如你可以用处理表单数据一样的方式处理JSON数据

.query_params

request.query_params是对于request.GET更准确的命名同义词,为清楚起见,在你的代码中,我们建议使用request.query_params来代替Django标准的request.GET。这样能够让你的代码库更正确和清晰,可能包括任何的HTTP方法类型查询参数,而不止于GET request.

.parsers

APIView类或@api_view装饰将确保这个属性将自动设置为Parser的实例列表,根据parser_classes设置视图或基于DEFAULT_PARSER_CLASSES设置。
通常你不需要访问该属性。

注意:
如果一个客户端发送畸形的内容,然后访问request.data,可能会导致一个ParseError,默认情况下 REST framework 的
APIView类或@api_view装饰将捕获错误并返回一个400错误请求响应。
如果一个客户端发送一个请求的内容类型不能解析,将抛出UnsupportedMediaType异常,默认情况下将被捕获并返回一个415 Unsupported Media Type 响应。


2.Content negotiation(内容协商)


request公开一些属性,允许您确定内容协商阶段的结果。这允许您实现为不同的媒体类型选择不同的连载方案等行为。

.accepted_renderer

The renderer instance what was selected by the content negotiation stage.(渲染器实例选择的内容协商阶段)

.accepted_media_type

一个字符串代表内容协商阶段接受的媒体类型。


3.Authentication


REST framework 提供了灵活并且针对每个request的身份认证系统,他允许你实现以下功能:

  • 为你的API不同的部分选用不同的身份认证策略
  • 提供了多个身份认证使用策略
  • 通过传入的request提供了用户的token信息的关联。

.user

request.user通常返回django.contrib.auth.models.User的实例,虽然这个行为取决于所使用的身份验证策略。
如果请求是未经身份验证的,request.user的默认值是django.contrib.auth.models.AnonymousUser的实例

For more details see the authentication documentation.

.auth

request.auth返回任何额外的身份认证环境(context),request.auth具体的行为取决于使用的身份认证策略,但是他通常是一个request身份认证的token实例
如果request未经身份验证,或者没有额外的环境,request.auth的默认值为None。

For more details see the authentication documentation.

.authenticators

APIView类或@api_view装饰将确保这个属性将自动设置为ofAuthentication实例列表,根据authentication_classes设置视图或基于DEFAULT_AUTHENTICATORS设置。

通常你不需要访问该属性。


4.浏览器增强


REST framework 支持一些浏览器增强,像基于浏览器的 PUT, PATCH 和 DELETE 形式。

.method

request.method返回request的HTTP方法的大写字符串表示。
基于浏览器的PUT,PATCH和DELETE形式是透明支持的。

For more information see the browser enhancements documentation.

.content_type

request.content_type 返回一个字符串对象代表HTTP的request body的媒体类型。
如果没有提供媒体类型则返回一个空字符串。
您通常不需要直接访问请求的内容类型,您将通常依赖于REST framework的默认请求解析行为。
如果你需要访问请求的内容类型你应该使用.content_type属性优先于使用request.META.get('HTTP_CONTENT_TYPE'),他提供基于浏览器的non-form内容的透明支持。

For more information see the browser enhancements documentation.

.stream

request.stream返回一个代表request body 内容的流。
你通常不需要直接的访问request的内容,你将通常依赖于REST framework的默认请求解析行为。
如果你需要直接访问原始内容,您应该使用.stream属性优先于使用request.content。他提供基于浏览器的non-form内容的透明支持。

For more information see the browser enhancements documentation.


5.标准HttpRequest属性


正如REST framework的Request扩展了Django的HttpRequest,所有其他标准的属性和方法也可可用的,例如:request.META和request.session字典可以正常使用。

注意,由于实现原因Request 类不从HttpRequest类继承,而是使用扩展类成分


二、response


REST framework 靠提供Response 类来支持HTTP内容协商,这个类允许你返回可以被渲染多种内容类型的的内容,具体类型取决于客户端的请求。

Response 类继承于Django的SimpleTemplateResponse,Response 对象被初始化为本地的Python原始数据组成的数据,REST framework使用标准的HTTP内容协商来决定怎样渲染最后的response数据。
这里没有要求你去使用Response 类,你可以根据需要在视图中返回正规的HttpResponse 或者StreamingHttpResponse 对象。使用Response 类简单的提供了一个漂亮的接口来返回协商的内容Web接口的响应,这可以被渲染成多种形式。
除非你因为一些原因还要大量定制REST framework,你应该一直在视图中使用APIView 类或者@api_view函数返回Response 对象。这些允许视图可以执行内容协商并为response选择适当的渲染器。

1.Response()


Response(data, status=None, template_name=None, headers=None, content_type=None)

不像正规的HttpResponse对象,你不用渲染的内容代替没有渲染的数据实例化Response对象,这可能由一些Python的原始数据组成。(Unlike regular HttpResponse objects, you do not instantiate Response objects with rendered content. Instead you pass in unrendered data, which may consist of any Python primitives.)

Response类使用的渲染器不能在本地处理复杂的数据类型,就像Django的模型实例,所以你需要在创建Response对象之前,先把数据序列化成原始的数据类型。
你可以使用REST framework的Serializer 类来执行这些数据序列化,或者使用你自己自定义的序列化器。

参数:

  • data:为response序列化的数据
  • status:为响应状态代码。默认为200。 See also status codes
  • template_name:如果选用HTMLRenderer ,为使用的模板名称。
  • headers:response中使用的HTTP头的字典。
  • content_type:response中内容的类型。通常这回被内容协商的渲染器设置成自动,但是这可能有一些原因你需要显式地指定内容类型。

2.属性


.data

Request 对象没有渲染的内容

.status_code

HTTP response的状态码

.content

response的渲染的内容,在访问.content之前必须先调用.render()方法。

.template_name

如果提供template_name,只需要HTMLRenderer 或者其他自定义模板渲染器是response接受的渲染器。

.accepted_renderer

用来渲染response的渲染器实例
在视图中返回response之前被APIView 或者@api_view立即设置为自动。

3.标准的HttpResponse属性


Response类扩展了SimpleTemplateResponse,所有常用的属性和方法在response中都是可用的。例如你可以在response中用标准的方式设置headers。

response = Response()
response['Cache-Control'] = 'no-cache'

.render()

** 参数:** .render()

与任何其他TemplateResponse一样,这个方法被用来渲染response的序列化的数据到最后的response内容。当.render()被调用时,response的内容会被设置成在accepted_renderer实例上调用.render(data, accepted_media_type, renderer_context) 方法的结果。
你通常不需要自己调用.render(),他被django的标准的response周期控制。

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

推荐阅读更多精彩内容