Responses

Responses

REST框架通过提供一个响应类来支持HTTP内容协商,该响应类允许您根据客户端请求将可呈现的内容渲染成多种内容类型。

Response类是Django的SimpleTemplateResponse的子类。响应对象使用data进行初始化,数据应包含本机Python原语。然后,REST框架使用标准HTTP content negotiation来确定如何呈现最终响应内容。

您不需要使用Response类,如果需要,还可以从视图中返回常规的HttpResponse或StreamingHttpResponse对象。使用Response类只需提供一个更好的界面来返回 content-negotiated Web API响应,可以渲染为多种格式。

除非您想要大量定制REST框架,否则您应该始终为返回Response对象的视图使用API​​View类或@api_view函数。这样做可以确保视图在从视图返回之前可以执行content negotiation并为响应选择适当的渲染器。

Creating responses

Response()

签名:响应(data,status = None,template_name = None,headers = None,content_type = None)

与常规HttpResponse对象不同,您不会将呈现内容的Response对象实例化。 而是传递未提交的数据,这些数据可能由任何Python基元组成。

Response类使用的渲染器无法本地处理诸如Django模型实例之类的复杂数据类型,因此您需要在创建Response对象之前将数据序列化为原始数据类型。

您可以使用REST框架的Serializer类来执行此数据序列化,或使用您自己的自定义序列化。

参数:

  • data: 响应的序列化数据。
  • status: 响应的状态码。默认为200.可查看响应码
  • template_name: 选择HTMLRenderer时要使用的模板名称。
  • headers: 用于响应的HTTP头字典。
  • content_type: 响应的内容类型。 通常,这将由渲染器自动设置,由content negotiation确定,但可能会出现某些情况,您需要明确指定内容类型。

Attributes

.data

Request对象的未呈现的内容。

.status_code

HTTP响应的数字状态代码。

.content

呈现内容的响应。 必须先调用.render()方法才能访问.content。

.template_name

template_name,如果提供。 仅当HTMLRenderer或其他自定义模板渲染器是响应的可用渲染器时才需要。

.accepted_renderer

用于渲染响应的渲染器实例。在视图返回响应之前,由APIView或@api_view自动设置。

.accepted_media_type

由content negotiation stage选择的媒体类型。由APIView自动设置或者在视图中返回响应之前的@api_view。

.renderer_context

将传递给渲染器的.render()方法的附加上下文信息的字典。由APIView自动设置或者在视图中返回响应之前的@api_view。

Standard HttpResponse attributes

Response类扩展了SimpleTemplateResponse,所有常见的属性和方法也可用于响应。 例如,您可以以标准方式在响应中设置头文件:

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

.render()

Signature: .render()
与任何其他TemplateResponse一样,调用此方法将响应的序列化数据呈现到最终响应内容中。 当.render()被调用时,响应内容将被设置为在accepted_renderer实例上调用.render(data,accepted_media_type,renderer_context)方法的结果。你通常不需要自己调用.render() 它由Django的标准响应周期处理。

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

推荐阅读更多精彩内容