2012-09-02 00:24:33 +04:00
<!DOCTYPE html>
< html lang = "en" > < head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
< title > Django REST framework< / title >
2012-10-05 18:26:53 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/img/favicon.ico" rel = "icon" type = "image/x-icon" >
2012-09-02 00:24:33 +04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "" >
< meta name = "author" content = "" >
<!-- Le styles -->
2012-09-08 23:24:07 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel = "stylesheet" >
2012-09-02 00:37:41 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/bootstrap.css" rel = "stylesheet" >
< link href = "http://tomchristie.github.com/django-rest-framework/css/bootstrap-responsive.css" rel = "stylesheet" >
2012-09-13 12:40:09 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/default.css" rel = "stylesheet" >
2012-09-02 00:24:33 +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]-->
2012-10-01 19:27:59 +04:00
< body onload = "prettyPrint()" class = "responses-page" >
2012-09-02 00:24:33 +04:00
2012-10-05 22:27:27 +04:00
< div class = "wrapper" >
2012-09-02 00:24:33 +04:00
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
2012-09-12 16:12:00 +04:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/tomchristie/django-rest-framework/tree/restframework2" > GitHub< / a >
2012-09-02 00:24:33 +04:00
< 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 >
2012-09-02 00:37:41 +04:00
< a class = "brand" href = "http://tomchristie.github.com/django-rest-framework" > Django REST framework< / a >
2012-09-02 00:24:33 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework" > Home< / a > < / li >
2012-09-02 00:24:33 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-10-09 15:01:56 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/quickstart" > Quickstart< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization" > 1 - Serialization< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/2-requests-and-responses" > 2 - Requests and responses< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/3-class-based-views" > 3 - Class based views< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/4-authentication-permissions-and-throttling" > 4 - Authentication, permissions and throttling< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/5-relationships-and-hyperlinked-apis" > 5 - Relationships and hyperlinked APIs< / a > < / li >
2012-10-10 12:36:47 +04:00
<!-- <li><a href="http://tomchristie.github.com/django - rest - framework/tutorial/6 - resource - orientated - projects">6 - Resource orientated projects</a></li> -->
2012-09-02 00:24:33 +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" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/requests" > Requests< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/responses" > Responses< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/views" > Views< / a > < / li >
2012-09-12 13:14:01 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/generic-views" > Generic views< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/parsers" > Parsers< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/renderers" > Renderers< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/serializers" > Serializers< / a > < / li >
2012-10-05 20:10:33 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/fields" > Serializer fields< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/authentication" > Authentication< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/permissions" > Permissions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/throttling" > Throttling< / a > < / li >
2012-10-01 19:27:59 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/pagination" > Pagination< / a > < / li >
2012-09-12 13:14:01 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/content-negotiation" > Content negotiation< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/format-suffixes" > Format suffixes< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/reverse" > Returning URLs< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/status-codes" > Status codes< / a > < / li >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/settings" > Settings< / a > < / li >
2012-09-02 00:24:33 +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" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/csrf" > Working with AJAX and CSRF< / a > < / li >
2012-10-13 18:09:05 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/browser-enhancements" > Browser enhancements< / a > < / li >
2012-10-13 18:35:46 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/browsable-api" > The Browsable API< / a > < / li >
2012-10-08 15:19:26 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/rest-hypermedia-hateoas" > REST, Hypermedia & HATEOAS< / a > < / li >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/contributing" > Contributing to REST framework< / a > < / li >
2012-10-08 15:19:26 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/migration" > 2.0 Migration Guide< / a > < / li >
2012-10-17 16:50:08 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/release-notes" > Release Notes< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/credits" > Credits< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
2012-10-09 17:13:19 +04:00
<!-- TODO
2012-09-08 11:03:30 +04:00
< 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 >
2012-10-09 17:13:19 +04:00
-->
2012-09-08 11:03:30 +04:00
< / ul >
2012-09-02 00:24:33 +04:00
< / div > <!-- /.nav - collapse -->
< / div >
< / div >
< / div >
2012-10-05 22:27:27 +04:00
< div class = "body-content" >
< div class = "container-fluid" >
< div class = "row-fluid" >
2012-10-05 16:22:18 +04:00
2012-10-05 22:27:27 +04:00
< div class = "span3" >
2012-10-08 15:19:26 +04:00
<!-- 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 >
-->
2012-10-05 22:27:27 +04:00
< 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 >
2012-10-17 16:50:08 +04:00
< li class = "main" > < a href = "#creating-responses" > Creating responses< / a > < / li >
2012-10-05 17:00:31 +04:00
< li > < a href = "#response()" > Response()< / a > < / li >
2012-10-05 16:22:18 +04:00
< li class = "main" > < a href = "#attributes" > Attributes< / a > < / li >
2012-10-01 19:27:59 +04:00
< li > < a href = "#data" > .data< / a > < / li >
2012-10-05 16:22:18 +04:00
< li > < a href = "#status_code" > .status_code< / a > < / li >
2012-10-01 19:27:59 +04:00
< li > < a href = "#content" > .content< / a > < / li >
2012-10-05 16:22:18 +04:00
< 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 >
2012-10-13 18:09:05 +04:00
< li > < a href = "#renderer_context" > .renderer_context< / a > < / li >
2012-10-17 16:50:08 +04:00
< li class = "main" > < a href = "#standard-httpresponse-attributes" > Standard HttpResponse attributes< / a > < / li >
< li > < a href = "#render()" > .render()< / a > < / li >
2012-09-02 00:24:33 +04:00
2012-10-05 22:27:27 +04:00
< / ul >
< / div >
2012-09-08 11:03:30 +04:00
< / div >
2012-09-02 00:24:33 +04:00
2012-10-05 22:27:27 +04:00
< div id = "main-content" class = "span9" >
< p > < a class = "github" href = "https://github.com/tomchristie/django-rest-framework/blob/restframework2/rest_framework/response.py" > < span class = "label label-info" > response.py< / span > < / a > < / p >
2012-09-09 01:06:49 +04:00
< h1 id = "responses" > Responses< / h1 >
2012-09-02 00:24:33 +04:00
< 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 >
2012-10-01 19:27:59 +04:00
< 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 primatives. 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 > objects from your views if you want, but it provides a nicer interface for returning Web API responses.< / 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 >
2012-10-05 16:22:18 +04:00
< hr / >
2012-10-17 16:50:08 +04:00
< h1 id = "creating-responses" > Creating responses< / h1 >
2012-10-05 17:00:31 +04:00
< h2 id = "response" > Response()< / h2 >
< p > < strong > Signature:< / strong > < code > Response(data, status=None, template_name=None, headers=None)< / code > < / p >
2012-10-01 19:27:59 +04:00
< 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 primatives.< / 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 primative 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 >
2012-10-05 16:22:18 +04:00
< p > Arguments:< / p >
< ul >
< li > < code > data< / code > : The serialized data for the response.< / li >
< li > < code > status< / code > : A status code for the response. Defaults to 200. See also < a href = "status-codes" > status codes< / a > .< / li >
2012-10-09 19:45:28 +04:00
< li > < code > template_name< / code > : A template name to use if < code > HTMLRenderer< / code > is selected.< / li >
2012-10-05 16:22:18 +04:00
< li > < code > headers< / code > : A dictionary of HTTP headers to use in the response.< / li >
< / ul >
< hr / >
< h1 id = "attributes" > Attributes< / h1 >
2012-10-01 19:27:59 +04:00
< h2 id = "data" > .data< / h2 >
2012-10-05 18:26:53 +04:00
< p > The unrendered content of a < code > Request< / code > object.< / p >
2012-10-05 16:22:18 +04:00
< h2 id = "status_code" > .status_code< / h2 >
< p > The numeric status code of the HTTP response.< / p >
2012-10-01 19:27:59 +04:00
< h2 id = "content" > .content< / h2 >
2012-10-05 18:26:53 +04:00
< p > The rendered content of the response. The < code > .render()< / code > method must have been called before < code > .content< / code > can be accessed.< / p >
2012-10-05 16:22:18 +04:00
< h2 id = "template_name" > .template_name< / h2 >
2012-10-09 19:45:28 +04:00
< 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 reponse.< / p >
2012-10-05 16:22:18 +04:00
< 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 >
2012-10-13 18:09:05 +04:00
< 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 >
2012-10-05 16:22:18 +04:00
< p > Set automatically by the < code > APIView< / code > or < code > @api_view< / code > immediately before the response is returned from the view.< / p >
2012-10-17 16:50:08 +04:00
< 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 methd 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 >
2012-10-05 22:27:27 +04:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
2012-09-02 00:24:33 +04:00
2012-10-05 18:26:53 +04:00
< div id = "push" > < / div >
2012-10-05 22:27:27 +04:00
< / div > <!-- /.wrapper -->
2012-10-05 18:26:53 +04:00
2012-10-05 22:27:27 +04:00
< footer class = "span12" >
2012-10-05 22:33:52 +04:00
< p > Sponsored by < a href = "http://dabapps.com/" > DabApps< / a > .< / a > < / p >
2012-10-05 22:27:27 +04:00
< / footer >
2012-10-05 18:26:53 +04:00
2012-09-02 00:24:33 +04:00
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js" > < / script >
2012-10-05 16:22:18 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/prettify-1.0.js" > < / script >
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-2.1.1-min.js" > < / script >
2012-09-02 00:24:33 +04:00
< script >
2012-09-08 11:03:30 +04:00
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
2012-09-12 13:14:01 +04:00
2012-09-17 23:21:26 +04:00
$('.dropdown-menu').on('click touchstart', function(event) {
2012-09-12 13:14:01 +04:00
event.stopPropagation();
});
2012-09-02 00:24:33 +04:00
< / script >
2012-10-01 19:27:59 +04:00
< / body > < / html >
