2013-11-17 22:26:41 +04:00
<!DOCTYPE html>
< html lang = "en" >
< head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2013-12-23 16:37:56 +04:00
< title > Responses - Django REST framework< / title >
2014-08-02 18:29:15 +04:00
< link href = "http://www.django-rest-framework.org/img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "http://www.django-rest-framework.org/api-guide/responses" / >
2013-11-17 22:26:41 +04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Responses, Creating responses, Attributes, Standard HttpResponse attributes" >
< meta name = "author" content = "Tom Christie" >
<!-- Le styles -->
2014-08-02 18:29:15 +04:00
< link href = "http://www.django-rest-framework.org/css/prettify.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/bootstrap.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "http://www.django-rest-framework.org/css/default.css" rel = "stylesheet" >
2013-11-17 22:26:41 +04:00
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18852272-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
< / script >
2014-07-15 18:02:49 +04:00
< style >
span.fusion-wrap a {
display: block;
margin-top: 10px;
color: black;
}
a.fusion-poweredby {
display: block;
margin-top: 10px;
}
@media (max-width: 767px) {
div.promo {display: none;}
}
< / style >
2013-11-17 22:26:41 +04:00
< / head >
< body onload = "prettyPrint()" class = "responses-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/tomchristie/django-rest-framework/tree/master" > GitHub< / a >
2014-08-02 18:29:15 +04:00
< a class = "repo-link btn btn-inverse btn-small " href = "../api-guide/views" > Next < i class = "icon-arrow-right icon-white" > < / i > < / a >
< a class = "repo-link btn btn-inverse btn-small " href = "../api-guide/requests" > < i class = "icon-arrow-left icon-white" > < / i > Previous< / a >
2013-11-17 22:26:41 +04:00
< a class = "repo-link btn btn-inverse btn-small" href = "#searchModal" data-toggle = "modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
2014-08-02 18:29:15 +04:00
< a class = "brand" href = "http://www.django-rest-framework.org" > Django REST framework< / a >
2013-11-17 22:26:41 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org" > Home< / a > < / li >
2013-11-17 22:26:41 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/tutorial/quickstart" > Quickstart< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/1-serialization" > 1 - Serialization< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/2-requests-and-responses" > 2 - Requests and responses< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/3-class-based-views" > 3 - Class based views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/4-authentication-and-permissions" > 4 - Authentication and permissions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis" > 5 - Relationships and hyperlinked APIs< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers" > 6 - Viewsets and routers< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/api-guide/requests" > Requests< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/responses" > Responses< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/views" > Views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/generic-views" > Generic views< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/viewsets" > Viewsets< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/routers" > Routers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/parsers" > Parsers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/renderers" > Renderers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/serializers" > Serializers< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/fields" > Serializer fields< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/relations" > Serializer relations< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/authentication" > Authentication< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/permissions" > Permissions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/throttling" > Throttling< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/filtering" > Filtering< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/pagination" > Pagination< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/content-negotiation" > Content negotiation< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/format-suffixes" > Format suffixes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/reverse" > Returning URLs< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/status-codes" > Status codes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/testing" > Testing< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/api-guide/settings" > Settings< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/documenting-your-api" > Documenting your API< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/ajax-csrf-cors" > AJAX, CSRF & CORS< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/browser-enhancements" > Browser enhancements< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/browsable-api" > The Browsable API< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/rest-hypermedia-hateoas" > REST, Hypermedia & HATEOAS< / a > < / li >
2014-09-17 17:12:41 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/third-party-resources" > Third Party Resources< / a > < / li >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/contributing" > Contributing to REST framework< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/rest-framework-2-announcement" > 2.0 Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/2.2-announcement" > 2.2 Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/2.3-announcement" > 2.3 Announcement< / a > < / li >
2014-08-29 13:11:44 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/2.4-announcement" > 2.4 Announcement< / a > < / li >
2014-08-02 18:29:15 +04:00
< li > < a href = "http://www.django-rest-framework.org/topics/kickstarter-announcement" > Kickstarter Announcement< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/release-notes" > Release Notes< / a > < / li >
< li > < a href = "http://www.django-rest-framework.org/topics/credits" > Credits< / a > < / li >
2013-11-17 22:26:41 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
<!-- TODO
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Version: 2.0.0 < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li > < a href = "#" > Trunk< / a > < / li >
< li > < a href = "#" > 2.0.0< / a > < / li >
< / ul >
< / li >
-->
< / ul >
< / div > <!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
< div id = "searchModal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × < / button >
< h3 id = "myModalLabel" > Documentation search< / h3 >
< / div >
< div class = "modal-body" >
<!-- Custom google search -->
< script >
(function() {
var cx = '015016005043623903336:rxraeohqk6w';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
< / script >
< gcse:search > < / gcse:search >
< / div >
< div class = "modal-footer" >
< button class = "btn" data-dismiss = "modal" aria-hidden = "true" > Close< / button >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span3" >
<!-- TODO
< p style = "margin-top: -12px" >
< a class = "btn btn-mini btn-primary" style = "width: 60px" > « previous< / a >
< a class = "btn btn-mini btn-primary" style = "float: right; margin-right: 8px; width: 60px;" > next » < / a >
< / p >
-->
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" > < a href = "#responses" > Responses< / a > < / li >
< li class = "main" > < a href = "#creating-responses" > Creating responses< / a > < / li >
< li > < a href = "#response()" > Response()< / a > < / li >
< li class = "main" > < a href = "#attributes" > Attributes< / a > < / li >
< li > < a href = "#data" > .data< / a > < / li >
< li > < a href = "#status_code" > .status_code< / a > < / li >
< li > < a href = "#content" > .content< / a > < / li >
< li > < a href = "#template_name" > .template_name< / a > < / li >
< li > < a href = "#accepted_renderer" > .accepted_renderer< / a > < / li >
< li > < a href = "#accepted_media_type" > .accepted_media_type< / a > < / li >
< li > < a href = "#renderer_context" > .renderer_context< / a > < / li >
< li class = "main" > < a href = "#standard-httpresponse-attributes" > Standard HttpResponse attributes< / a > < / li >
< li > < a href = "#render()" > .render()< / a > < / li >
2014-07-15 18:02:49 +04:00
< div class = "promo" >
< / div >
2014-01-03 17:26:35 +04:00
< / ul >
2013-11-17 22:26:41 +04:00
< / div >
< / div >
< div id = "main-content" class = "span9" >
< p > < a class = "github" href = "https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/response.py" > < span class = "label label-info" > response.py< / span > < / a > < / p >
< h1 id = "responses" > Responses< / h1 >
< blockquote >
< p > Unlike basic HttpResponse objects, TemplateResponse objects retain the details of the context that was provided by the view to compute the response. The final output of the response is not computed until it is needed, later in the response process.< / p >
< p > — < a href = "https://docs.djangoproject.com/en/dev/ref/template-response/" > Django documentation< / a > < / p >
< / blockquote >
< p > REST framework supports HTTP content negotiation by providing a < code > Response< / code > class which allows you to return content that can be rendered into multiple content types, depending on the client request.< / p >
< p > The < code > Response< / code > class subclasses Django's < code > SimpleTemplateResponse< / code > . < code > Response< / code > objects are initialised with data, which should consist of native Python primitives. REST framework then uses standard HTTP content negotiation to determine how it should render the final response content.< / p >
< p > There's no requirement for you to use the < code > Response< / code > class, you can also return regular < code > HttpResponse< / code > or < code > StreamingHttpResponse< / code > objects from your views if required. Using the < code > Response< / code > class simply provides a nicer interface for returning content-negotiated Web API responses, that can be rendered to multiple formats.< / p >
< p > Unless you want to heavily customize REST framework for some reason, you should always use an < code > APIView< / code > class or < code > @api_view< / code > function for views that return < code > Response< / code > objects. Doing so ensures that the view can perform content negotiation and select the appropriate renderer for the response, before it is returned from the view.< / p >
< hr / >
< h1 id = "creating-responses" > Creating responses< / h1 >
< h2 id = "response" > Response()< / h2 >
< p > < strong > Signature:< / strong > < code > Response(data, status=None, template_name=None, headers=None, content_type=None)< / code > < / p >
< p > Unlike regular < code > HttpResponse< / code > objects, you do not instantiate < code > Response< / code > objects with rendered content. Instead you pass in unrendered data, which may consist of any Python primitives.< / p >
< p > The renderers used by the < code > Response< / code > class cannot natively handle complex datatypes such as Django model instances, so you need to serialize the data into primitive datatypes before creating the < code > Response< / code > object.< / p >
< p > You can use REST framework's < code > Serializer< / code > classes to perform this data serialization, or use your own custom serialization.< / p >
< p > Arguments:< / p >
< ul >
< li > < code > data< / code > : The serialized data for the response.< / li >
2014-08-02 18:29:15 +04:00
< li > < code > status< / code > : A status code for the response. Defaults to 200. See also < a href = "status-codes" > status codes< / a > .< / li >
2013-11-17 22:26:41 +04:00
< li > < code > template_name< / code > : A template name to use if < code > HTMLRenderer< / code > is selected.< / li >
< li > < code > headers< / code > : A dictionary of HTTP headers to use in the response.< / li >
< li > < code > content_type< / code > : The content type of the response. Typically, this will be set automatically by the renderer as determined by content negotiation, but there may be some cases where you need to specify the content type explicitly.< / li >
< / ul >
< hr / >
< h1 id = "attributes" > Attributes< / h1 >
< h2 id = "data" > .data< / h2 >
< p > The unrendered content of a < code > Request< / code > object.< / p >
< h2 id = "status_code" > .status_code< / h2 >
< p > The numeric status code of the HTTP response.< / p >
< h2 id = "content" > .content< / h2 >
< p > The rendered content of the response. The < code > .render()< / code > method must have been called before < code > .content< / code > can be accessed.< / p >
< h2 id = "template_name" > .template_name< / h2 >
< p > The < code > template_name< / code > , if supplied. Only required if < code > HTMLRenderer< / code > or some other custom template renderer is the accepted renderer for the response.< / p >
< h2 id = "accepted_renderer" > .accepted_renderer< / h2 >
< p > The renderer instance that will be used to render the response.< / p >
< p > Set automatically by the < code > APIView< / code > or < code > @api_view< / code > immediately before the response is returned from the view.< / p >
< h2 id = "accepted_media_type" > .accepted_media_type< / h2 >
< p > The media type that was selected by the content negotiation stage.< / p >
< p > Set automatically by the < code > APIView< / code > or < code > @api_view< / code > immediately before the response is returned from the view.< / p >
< h2 id = "renderer_context" > .renderer_context< / h2 >
< p > A dictionary of additional context information that will be passed to the renderer's < code > .render()< / code > method.< / p >
< p > Set automatically by the < code > APIView< / code > or < code > @api_view< / code > immediately before the response is returned from the view.< / p >
< hr / >
< h1 id = "standard-httpresponse-attributes" > Standard HttpResponse attributes< / h1 >
< p > The < code > Response< / code > class extends < code > SimpleTemplateResponse< / code > , and all the usual attributes and methods are also available on the response. For example you can set headers on the response in the standard way:< / p >
< pre class = "prettyprint lang-py" > < code > response = Response()
response['Cache-Control'] = 'no-cache'
< / code > < / pre >
< h2 id = "render" > .render()< / h2 >
< p > < strong > Signature:< / strong > < code > .render()< / code > < / p >
< p > As with any other < code > TemplateResponse< / code > , this method is called to render the serialized data of the response into the final response content. When < code > .render()< / code > is called, the response content will be set to the result of calling the < code > .render(data, accepted_media_type, renderer_context)< / code > method on the < code > accepted_renderer< / code > instance.< / p >
< p > You won't typically need to call < code > .render()< / code > yourself, as it's handled by Django's standard response cycle.< / p >
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
< div id = "push" > < / div >
< / div > <!-- /.wrapper -->
< footer class = "span12" >
< p > Sponsored by < a href = "http://dabapps.com/" > DabApps< / a > .< / a > < / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2014-08-02 18:29:15 +04:00
< script src = "http://www.django-rest-framework.org/js/jquery-1.8.1-min.js" > < / script >
< script src = "http://www.django-rest-framework.org/js/prettify-1.0.js" > < / script >
< script src = "http://www.django-rest-framework.org/js/bootstrap-2.1.1-min.js" > < / script >
2014-07-15 18:02:49 +04:00
2013-11-17 22:26:41 +04:00
< script >
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
// Dynamically force sidenav to no higher than browser window
$('.side-nav').css('max-height', window.innerHeight - 130);
$(function(){
$(window).resize(function(){
$('.side-nav').css('max-height', window.innerHeight - 130);
});
});
< / script >
< / body > < / html >
