REST framework是通过提供一个Response
类来支持HTTP的内容协商能力的。这个类允许你根据不同的客户端请求来把返回内容渲染成不同的内容类型。
Response
类继承了Django的SimpleTemplateResponse
。Response
对象是用包含了Python原始类型的数据来初始化的。REST framework之后会使用标准的HTTP内容协商方式来决定它如何渲染最终的返回内容。
并没有强制要求说你必须使用Response
类,如果需要,你仍然可以从你的视图里返回普通的HttpResponse
类或者StreamingHttpResponse
对象。使用Response
类只是单纯的提供了一个更友好的接口给要返回的需要内容协商的,将会被渲染成多种格式的网络API返回
除非你因为某种原因需要重度定制REST framework,不然你总应该使用APIView
类或者@api_view
功能给哪些要返回的Response
对象。这样做是保证response在从view返回之前执行内容协商并且选择合适的渲染器渲染response。
创建responses
签名: Response(data, status=None, template_name=None, headers=None, content_type=None)
不像普通的HttpResponse
对象,你不需要用渲染过的内容来初始化Response
。相反你可以传入没有渲染的可以由任何Python基本类型构成的数据。
Response
类使用的渲染器本来不能处理类似Django model实例这样的复杂数据,所以你需要在创建Response
之前把数据序列化为原始类型数据。
你可以使用REST framework的Serializer
类来执行这种数据的序列化,或者使用你自己定制的序列化器。
参数:
- data: 给response序列化过的数据
- status: response默认的状态码。默认值为200. 详细查看status codes.
- template_name: 模板名称,如果选定了
HTMLRenderer
- headers: 在response中使用的一个字典表示HTTP头
- content_type: 这个response的内容类型。一般来说,这个会由内容协商的渲染器自动设置,但是也有一些情况你需要自己明确指定的
属性
.data
一个Request
对象没有渲染的内容
.status_code
HTTP response的数字状态码
.content
response的渲染过的内容。.render()
方法必须在.content
被访问之前调用。
.template_name
template_name
模板名称,如果HTMLRenderer
或者其他的定制的模板渲染器被设置为response的可接受渲染器,那么它是必须提供的
.accepted_renderer
渲染response用的渲染器对象。
会在response从view返回之前马上被APIView
或者@api_view
设置。
.accepted_media_type
媒体类型是在内容协商阶段被选定的
会在response从view返回之前马上被APIView
或者@api_view
设置。
.render_context
一个字典的额外信息将会被传入渲染器的.render()
方法
会在response从view返回之前马上被APIView
或者@api_view
设置。
标准HttpResponse
属性
Response
类扩展自SimpleTemplateResponse
,所有基本的属性和方法任然可用。举例你可以用标准的方法给response的header设置信息。
.render()
和其他任何TemplateResponse
一样,这个方法是把序列化的对象渲染成为最终response里的内容。当.render()
被调用,response里的内容将被设置为在accepted_render
实例上调用.render(data,accepted_media_type, renderer_context)方法之后的结果 你一般不会去自己调用
.render()```,因为它已经被Django的标准response循环处理了。