diff options
Diffstat (limited to 'api-guide/renderers.html')
| -rw-r--r-- | api-guide/renderers.html | 116 |
1 files changed, 58 insertions, 58 deletions
diff --git a/api-guide/renderers.html b/api-guide/renderers.html index cf22546f..b796a273 100644 --- a/api-guide/renderers.html +++ b/api-guide/renderers.html @@ -3,17 +3,17 @@ <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <title>Renderers - Django REST framework</title> - <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/renderers"/> + <link href="file:///Users/tomchristie/GitHub/django-rest-framework/html//img/favicon.ico" rel="icon" type="image/x-icon"> + <link rel="canonical" href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/renderers.html"/> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content="Django, API, REST, Renderers, API Reference, Custom renderers, Advanced renderer usage, Third party packages"> <meta name="author" content="Tom Christie"> <!-- Le styles --> - <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"> + <link href="file:///Users/tomchristie/GitHub/django-rest-framework/html//css/prettify.css" rel="stylesheet"> + <link href="file:///Users/tomchristie/GitHub/django-rest-framework/html//css/bootstrap.css" rel="stylesheet"> + <link href="file:///Users/tomchristie/GitHub/django-rest-framework/html//css/bootstrap-responsive.css" rel="stylesheet"> + <link href="file:///Users/tomchristie/GitHub/django-rest-framework/html//css/default.css" rel="stylesheet"> <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> <!--[if lt IE 9]> @@ -57,73 +57,73 @@ a.fusion-poweredby { <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> - <a class="repo-link btn btn-inverse btn-small " href="../api-guide/serializers">Next <i class="icon-arrow-right icon-white"></i></a> - <a class="repo-link btn btn-inverse btn-small " href="../api-guide/parsers"><i class="icon-arrow-left icon-white"></i> Previous</a> + <a class="repo-link btn btn-inverse btn-small " href="../api-guide/serializers.html">Next <i class="icon-arrow-right icon-white"></i></a> + <a class="repo-link btn btn-inverse btn-small " href="../api-guide/parsers.html"><i class="icon-arrow-left icon-white"></i> Previous</a> <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> - <a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a> + <a class="brand" href="file:///Users/tomchristie/GitHub/django-rest-framework/html/index.html">Django REST framework</a> <div class="nav-collapse collapse"> <ul class="nav"> - <li><a href="http://www.django-rest-framework.org">Home</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html/index.html">Home</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a> <ul class="dropdown-menu"> - <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> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/quickstart.html">Quickstart</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/1-serialization.html">1 - Serialization</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/2-requests-and-responses.html">2 - Requests and responses</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/3-class-based-views.html">3 - Class based views</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/4-authentication-and-permissions.html">4 - Authentication and permissions</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/5-relationships-and-hyperlinked-apis.html">5 - Relationships and hyperlinked APIs</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//tutorial/6-viewsets-and-routers.html">6 - Viewsets and routers</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a> <ul class="dropdown-menu"> - <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> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/requests.html">Requests</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/responses.html">Responses</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/views.html">Views</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/generic-views.html">Generic views</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/viewsets.html">Viewsets</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/routers.html">Routers</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/parsers.html">Parsers</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/renderers.html">Renderers</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/serializers.html">Serializers</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/fields.html">Serializer fields</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/relations.html">Serializer relations</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/authentication.html">Authentication</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/permissions.html">Permissions</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/throttling.html">Throttling</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/filtering.html">Filtering</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/pagination.html">Pagination</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/content-negotiation.html">Content negotiation</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/format-suffixes.html">Format suffixes</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/reverse.html">Returning URLs</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/exceptions.html">Exceptions</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/status-codes.html">Status codes</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/testing.html">Testing</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//api-guide/settings.html">Settings</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a> <ul class="dropdown-menu"> - <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> - <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> - <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> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/documenting-your-api.html">Documenting your API</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/ajax-csrf-cors.html">AJAX, CSRF & CORS</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/browser-enhancements.html">Browser enhancements</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/browsable-api.html">The Browsable API</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/rest-hypermedia-hateoas.html">REST, Hypermedia & HATEOAS</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/contributing.html">Contributing to REST framework</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/rest-framework-2-announcement.html">2.0 Announcement</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/2.2-announcement.html">2.2 Announcement</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/2.3-announcement.html">2.3 Announcement</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/kickstarter-announcement.html">Kickstarter Announcement</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/release-notes.html">Release Notes</a></li> + <li><a href="file:///Users/tomchristie/GitHub/django-rest-framework/html//topics/credits.html">Credits</a></li> </ul> </li> </ul> @@ -233,7 +233,7 @@ a.fusion-poweredby { <h2 id="how-the-renderer-is-determined">How the renderer is determined</h2> <p>The set of valid renderers for a view is always defined as a list of classes. When a view is entered REST framework will perform content negotiation on the incoming request, and determine the most appropriate renderer to satisfy the request.</p> <p>The basic process of content negotiation involves examining the request's <code>Accept</code> header, to determine which media types it expects in the response. Optionally, format suffixes on the URL may be used to explicitly request a particular representation. For example the URL <code>http://example.com/api/users_count.json</code> might be an endpoint that always returns JSON data.</p> -<p>For more information see the documentation on <a href="content-negotiation">content negotiation</a>.</p> +<p>For more information see the documentation on <a href="content-negotiation.html">content negotiation</a>.</p> <h2 id="setting-the-renderers">Setting the renderers</h2> <p>The default set of renderers may be set globally, using the <code>DEFAULT_RENDERER_CLASSES</code> setting. For example, the following settings would use <code>YAML</code> as the main media type and also include the self describing API.</p> <pre class="prettyprint lang-py"><code>REST_FRAMEWORK = { @@ -309,7 +309,7 @@ def user_count_view(request, format=None): <p>Renders the request data into <code>JSONP</code>. The <code>JSONP</code> media type provides a mechanism of allowing cross-domain AJAX requests, by wrapping a <code>JSON</code> response in a javascript callback.</p> <p>The javascript callback function must be set by the client including a <code>callback</code> URL query parameter. For example <code>http://example.com/api/users?callback=jsonpCallback</code>. If the callback function is not explicitly set by the client it will default to <code>'callback'</code>.</p> <hr /> -<p><strong>Warning</strong>: If you require cross-domain AJAX requests, you should almost certainly be using the more modern approach of <a href="http://www.w3.org/TR/cors/">CORS</a> as an alternative to <code>JSONP</code>. See the <a href="../topics/ajax-csrf-cors">CORS documentation</a> for more details.</p> +<p><strong>Warning</strong>: If you require cross-domain AJAX requests, you should almost certainly be using the more modern approach of <a href="http://www.w3.org/TR/cors/">CORS</a> as an alternative to <code>JSONP</code>. See the <a href="../topics/ajax-csrf-cors.html">CORS documentation</a> for more details.</p> <p>The <code>jsonp</code> approach is essentially a browser hack, and is <a href="http://stackoverflow.com/questions/613962/is-jsonp-safe-to-use">only appropriate for globally readable API endpoints</a>, where <code>GET</code> requests are unauthenticated and do not require any user permissions.</p> <hr /> <p><strong>.media_type</strong>: <code>application/javascript</code></p> @@ -402,7 +402,7 @@ def simple_html_view(request): return JSONRenderer() </code></pre> <h2 id="multipartrenderer">MultiPartRenderer</h2> -<p>This renderer is used for rendering HTML multipart form data. <strong>It is not suitable as a response renderer</strong>, but is instead used for creating test requests, using REST framework's <a href="testing">test client and test request factory</a>.</p> +<p>This renderer is used for rendering HTML multipart form data. <strong>It is not suitable as a response renderer</strong>, but is instead used for creating test requests, using REST framework's <a href="testing.html">test client and test request factory</a>.</p> <p><strong>.media_type</strong>: <code>multipart/form-data; boundary=BoUnDaRyStRiNg</code></p> <p><strong>.format</strong>: <code>'.multipart'</code></p> <p><strong>.charset</strong>: <code>utf-8</code></p> @@ -534,9 +534,9 @@ In this case you can underspecify the media types it should respond to, by using <!-- Le javascript ================================================== --> <!-- Placed at the end of the document so the pages load faster --> - <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> + <script src="file:///Users/tomchristie/GitHub/django-rest-framework/html//js/jquery-1.8.1-min.js"></script> + <script src="file:///Users/tomchristie/GitHub/django-rest-framework/html//js/prettify-1.0.js"></script> + <script src="file:///Users/tomchristie/GitHub/django-rest-framework/html//js/bootstrap-2.1.1-min.js"></script> <script> //$('.side-nav').scrollspy() |