<!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <title>Browser Enhancements - Django REST framework</title> <link href="../../img/favicon.ico" rel="icon" type="image/x-icon"> <link rel="canonical" href="http://www.django-rest-framework.org/topics/browser-enhancements/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content="Django, API, REST, Browser Enhancements"> <meta name="author" content="Tom Christie"> <!-- Le styles --> <link href="../../css/prettify.css" rel="stylesheet"> <link href="../../css/bootstrap.css" rel="stylesheet"> <link href="../../css/bootstrap-responsive.css" rel="stylesheet"> <link href="../../css/default.css" rel="stylesheet"> <!-- 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> <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> </head> <body onload="prettyPrint()" class="-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> <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../browsable-api/"> Next <i class="icon-arrow-right icon-white"></i> </a> <a class="repo-link btn btn-inverse btn-small " rel="next" href="../html-and-forms/"> <i class="icon-arrow-left icon-white"></i> Previous </a> <a id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_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> <div class="nav-collapse collapse"> <!-- Main navigation --> <ul class="nav navbar-nav"> <li > <a href="../..">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="../../tutorial/quickstart/">Quickstart</a> </li> <li > <a href="../../tutorial/1-serialization/">1 - Serialization</a> </li> <li > <a href="../../tutorial/2-requests-and-responses/">2 - Requests and responses</a> </li> <li > <a href="../../tutorial/3-class-based-views/">3 - Class based views</a> </li> <li > <a href="../../tutorial/4-authentication-and-permissions/">4 - Authentication and permissions</a> </li> <li > <a href="../../tutorial/5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a> </li> <li > <a href="../../tutorial/6-viewsets-and-routers/">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="../../api-guide/requests/">Requests</a> </li> <li > <a href="../../api-guide/responses/">Responses</a> </li> <li > <a href="../../api-guide/views/">Views</a> </li> <li > <a href="../../api-guide/generic-views/">Generic views</a> </li> <li > <a href="../../api-guide/viewsets/">Viewsets</a> </li> <li > <a href="../../api-guide/routers/">Routers</a> </li> <li > <a href="../../api-guide/parsers/">Parsers</a> </li> <li > <a href="../../api-guide/renderers/">Renderers</a> </li> <li > <a href="../../api-guide/serializers/">Serializers</a> </li> <li > <a href="../../api-guide/fields/">Serializer fields</a> </li> <li > <a href="../../api-guide/relations/">Serializer relations</a> </li> <li > <a href="../../api-guide/validators/">Validators</a> </li> <li > <a href="../../api-guide/authentication/">Authentication</a> </li> <li > <a href="../../api-guide/permissions/">Permissions</a> </li> <li > <a href="../../api-guide/throttling/">Throttling</a> </li> <li > <a href="../../api-guide/filtering/">Filtering</a> </li> <li > <a href="../../api-guide/pagination/">Pagination</a> </li> <li > <a href="../../api-guide/versioning/">Versioning</a> </li> <li > <a href="../../api-guide/content-negotiation/">Content negotiation</a> </li> <li > <a href="../../api-guide/metadata/">Metadata</a> </li> <li > <a href="../../api-guide/format-suffixes/">Format suffixes</a> </li> <li > <a href="../../api-guide/reverse/">Returning URLs</a> </li> <li > <a href="../../api-guide/exceptions/">Exceptions</a> </li> <li > <a href="../../api-guide/status-codes/">Status codes</a> </li> <li > <a href="../../api-guide/testing/">Testing</a> </li> <li > <a href="../../api-guide/settings/">Settings</a> </li> </ul> </li> <li class="dropdown active"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a> <ul class="dropdown-menu"> <li > <a href="../documenting-your-api/">Documenting your API</a> </li> <li > <a href="../internationalization/">Internationalization</a> </li> <li > <a href="../ajax-csrf-cors/">AJAX, CSRF & CORS</a> </li> <li > <a href="../html-and-forms/">HTML & Forms</a> </li> <li class="active" > <a href="./">Browser Enhancements</a> </li> <li > <a href="../browsable-api/">The Browsable API</a> </li> <li > <a href="../rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a> </li> <li > <a href="../third-party-resources/">Third Party Resources</a> </li> <li > <a href="../contributing/">Contributing to REST framework</a> </li> <li > <a href="../project-management/">Project management</a> </li> <li > <a href="../3.0-announcement/">3.0 Announcement</a> </li> <li > <a href="../3.1-announcement/">3.1 Announcement</a> </li> <li > <a href="../3.2-announcement/">3.2 Announcement</a> </li> <li > <a href="../3.3-announcement/">3.3 Announcement</a> </li> <li > <a href="../kickstarter-announcement/">Kickstarter Announcement</a> </li> <li > <a href="../release-notes/">Release Notes</a> </li> </ul> </li> </ul> </div> <!--/.nav-collapse --> </div> </div> </div> <div class="body-content"> <div class="container-fluid"> <!-- Search Modal --> <div id="mkdocs_search_modal" 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"> <form role="form" autocomplete="off"> <div class="form-group"> <input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query"> </div> </form> <div id="mkdocs-search-results"></div> </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"> <div id="table-of-contents"> <ul class="nav nav-list side-nav well sidebar-nav-fixed"> <li class="main"> <a href="#browser-enhancements">Browser enhancements</a> </li> <li> <a href="#browser-based-put-delete-etc">Browser based PUT, DELETE, etc...</a> </li> <li> <a href="#browser-based-submission-of-non-form-content">Browser based submission of non-form content</a> </li> <li> <a href="#url-based-format-suffixes">URL based format suffixes</a> </li> <li> <a href="#http-header-based-method-overriding">HTTP header based method overriding</a> </li> <li> <a href="#url-based-accept-headers">URL based accept headers</a> </li> <li> <a href="#doesnt-html5-support-put-and-delete-forms">Doesn't HTML5 support PUT and DELETE forms?</a> </li> </ul> </div> </div> <div id="main-content" class="span9"> <h1 id="browser-enhancements"><a class="toclink" href="#browser-enhancements">Browser enhancements</a></h1> <blockquote> <p>"There are two noncontroversial uses for overloaded POST. The first is to <em>simulate</em> HTTP's uniform interface for clients like web browsers that don't support PUT or DELETE"</p> <p>— <a href="http://www.amazon.com/Restful-Web-Services-Leonard-Richardson/dp/0596529260">RESTful Web Services</a>, Leonard Richardson & Sam Ruby.</p> </blockquote> <p>In order to allow the browsable API to function, there are a couple of browser enhancements that REST framework needs to provide.</p> <p>As of version 3.3.0 onwards these are enabled with javascript, using the <a href="https://github.com/tomchristie/ajax-form">ajax-form</a> library.</p> <h2 id="browser-based-put-delete-etc"><a class="toclink" href="#browser-based-put-delete-etc">Browser based PUT, DELETE, etc...</a></h2> <p>The <a href="https://github.com/tomchristie/ajax-form">AJAX form library</a> supports browser-based <code>PUT</code>, <code>DELETE</code> and other methods on HTML forms.</p> <p>After including the library, use the <code>data-method</code> attribute on the form, like so:</p> <pre><code><form action="/" data-method="PUT"> <input name='foo'/> ... </form> </code></pre> <p>Note that prior to 3.3.0, this support was server-side rather than javascript based. The method overloading style (as used in <a href="http://guides.rubyonrails.org/form_helpers.html#how-do-forms-with-put-or-delete-methods-work">Ruby on Rails</a>) is no longer supported due to subtle issues that it introduces in request parsing.</p> <h2 id="browser-based-submission-of-non-form-content"><a class="toclink" href="#browser-based-submission-of-non-form-content">Browser based submission of non-form content</a></h2> <p>Browser-based submission of content types such as JSON are supported by the <a href="https://github.com/tomchristie/ajax-form">AJAX form library</a>, using form fields with <code>data-override='content-type'</code> and <code>data-override='content'</code> attributes.</p> <p>For example:</p> <pre><code> <form action="/"> <input data-override='content-type' value='application/json' type='hidden'/> <textarea data-override='content'>{}</textarea> <input type="submit"/> </form> </code></pre> <p>Note that prior to 3.3.0, this support was server-side rather than javascript based.</p> <h2 id="url-based-format-suffixes"><a class="toclink" href="#url-based-format-suffixes">URL based format suffixes</a></h2> <p>REST framework can take <code>?format=json</code> style URL parameters, which can be a useful shortcut for determining which content type should be returned from the view.</p> <p>This behavior is controlled using the <code>URL_FORMAT_OVERRIDE</code> setting.</p> <h2 id="http-header-based-method-overriding"><a class="toclink" href="#http-header-based-method-overriding">HTTP header based method overriding</a></h2> <p>Prior to version 3.3.0 the semi extension header <code>X-HTTP-Method-Override</code> was supported for overriding the request method. This behavior is no longer in core, but can be adding if needed using middleware.</p> <p>For example:</p> <pre><code>METHOD_OVERRIDE_HEADER = 'HTTP_X_HTTP_METHOD_OVERRIDE' class MethodOverrideMiddleware(object): def process_view(self, request, callback, callback_args, callback_kwargs): if request.method != 'POST': return if METHOD_OVERRIDE_HEADER not in request.META: return request.method = request.META[METHOD_OVERRIDE_HEADER] </code></pre> <h2 id="url-based-accept-headers"><a class="toclink" href="#url-based-accept-headers">URL based accept headers</a></h2> <p>Until version 3.3.0 REST framework included built-in support for <code>?accept=application/json</code> style URL parameters, which would allow the <code>Accept</code> header to be overridden.</p> <p>Since the introduction of the content negotiation API this behavior is no longer included in core, but may be added using a custom content negotiation class, if needed.</p> <p>For example:</p> <pre><code>class AcceptQueryParamOverride() def get_accept_list(self, request): header = request.META.get('HTTP_ACCEPT', '*/*') header = request.query_params.get('_accept', header) return [token.strip() for token in header.split(',')] </code></pre> <h2 id="doesnt-html5-support-put-and-delete-forms"><a class="toclink" href="#doesnt-html5-support-put-and-delete-forms">Doesn't HTML5 support PUT and DELETE forms?</a></h2> <p>Nope. It was at one point intended to support <code>PUT</code> and <code>DELETE</code> forms, but was later <a href="http://www.w3.org/TR/html5-diff/#changes-2010-06-24">dropped from the spec</a>. There remains <a href="http://amundsen.com/examples/put-delete-forms/">ongoing discussion</a> about adding support for <code>PUT</code> and <code>DELETE</code>, as well as how to support content types other than form-encoded data.</p> </div> <!--/span--> </div> <!--/row--> </div> <!--/.fluid-container--> </div> <!--/.body content--> <div id="push"></div> </div> <!--/.wrapper --> <footer class="span12"> <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>. </p> </footer> <!-- Le javascript ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="../../js/jquery-1.8.1-min.js"></script> <script src="../../js/prettify-1.0.js"></script> <script src="../../js/bootstrap-2.1.1-min.js"></script> <script>var base_url = '../..';</script> <script src="../../mkdocs/js/require.js"></script> <script src="../../js/theme.js"></script> <script> 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/dropdown to no higher than browser window $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130); $(function() { $(window).resize(function() { $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130); }); }); </script> </body> </html>