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-08 15:19:26 +04:00
< link href = "file:///Users/tom/github/django-rest-framework/html//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-10-08 15:19:26 +04:00
< link href = "file:///Users/tom/github/django-rest-framework/html//css/prettify.css" rel = "stylesheet" >
< link href = "file:///Users/tom/github/django-rest-framework/html//css/bootstrap.css" rel = "stylesheet" >
< link href = "file:///Users/tom/github/django-rest-framework/html//css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "file:///Users/tom/github/django-rest-framework/html//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 = "formoverloading-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-10-08 15:19:26 +04:00
< a class = "brand" href = "file:///Users/tom/github/django-rest-framework/html/index.html" > Django REST framework< / a >
2012-09-02 00:24:33 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2012-10-08 15:19:26 +04:00
< li > < a href = "file:///Users/tom/github/django-rest-framework/html/index.html" > 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-08 15:19:26 +04:00
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/1-serialization.html" > 1 - Serialization< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/2-requests-and-responses.html" > 2 - Requests and responses< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/3-class-based-views.html" > 3 - Class based views< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/4-authentication-permissions-and-throttling.html" > 4 - Authentication, permissions and throttling< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/5-relationships-and-hyperlinked-apis.html" > 5 - Relationships and hyperlinked APIs< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//tutorial/6-resource-orientated-projects.html" > 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-10-08 15:19:26 +04:00
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/requests.html" > Requests< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/responses.html" > Responses< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/views.html" > Views< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/generic-views.html" > Generic views< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/parsers.html" > Parsers< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/renderers.html" > Renderers< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/serializers.html" > Serializers< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/fields.html" > Serializer fields< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/authentication.html" > Authentication< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/permissions.html" > Permissions< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/throttling.html" > Throttling< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/pagination.html" > Pagination< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/content-negotiation.html" > Content negotiation< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/format-suffixes.html" > Format suffixes< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/reverse.html" > Returning URLs< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/exceptions.html" > Exceptions< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/status-codes.html" > Status codes< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//api-guide/settings.html" > 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-10-08 15:19:26 +04:00
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/csrf.html" > Working with AJAX and CSRF< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/formoverloading.html" > Browser based PUT, PATCH and DELETE< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/browsable-api.html" > Working with the browsable API< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/contributing.html" > Contributing to REST framework< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/migration.html" > 2.0 Migration Guide< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/changelog.html" > Change Log< / a > < / li >
< li > < a href = "file:///Users/tom/github/django-rest-framework/html//topics/credits.html" > Credits< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
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 >
< / 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 = "#browser-hacks" > Browser hacks< / a > < / li >
2012-10-05 01:32:43 +04:00
< 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-accept-headers" > URL based accept headers< / a > < / li >
< li > < a href = "#url-based-format-suffixes" > URL based format suffixes< / a > < / li >
2012-09-02 00:24:33 +04:00
< li > < a href = "#doesnt-html5-support-put-and-delete-forms" > Doesn't HTML5 support PUT and DELETE forms?< / a > < / li >
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" >
< h1 id = "browser-hacks" > Browser hacks< / h1 >
2012-09-02 00:24:33 +04:00
< 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 = "1" > RESTful Web Services< / a > , Leonard Richardson & Sam Ruby.< / p >
< / blockquote >
2012-10-05 01:32:43 +04:00
< h2 id = "browser-based-put-delete-etc" > Browser based PUT, DELETE, etc...< / h2 >
2012-09-02 00:24:33 +04:00
< p > < strong > TODO: Preamble.< / strong > Note that this is the same strategy as is used in < a href = "2" > Ruby on Rails< / a > .< / p >
< p > For example, given the following form:< / p >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > < form action="/news-items/5" method="POST">
2012-09-02 00:24:33 +04:00
< input type="hidden" name="_method" value="DELETE">
< /form>
< / code > < / pre >
< p > < code > request.method< / code > would return < code > "DELETE"< / code > .< / p >
2012-10-05 01:32:43 +04:00
< h2 id = "browser-based-submission-of-non-form-content" > Browser based submission of non-form content< / h2 >
2012-09-02 00:24:33 +04:00
< p > Browser-based submission of content types other than form are supported by using form fields named < code > _content< / code > and < code > _content_type< / code > :< / p >
< p > For example, given the following form:< / p >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > < form action="/news-items/5" method="PUT">
2012-09-02 00:24:33 +04:00
< input type="hidden" name="_content_type" value="application/json">
< input name="_content" value="{'count': 1}">
< /form>
< / code > < / pre >
< p > < code > request.content_type< / code > would return < code > "application/json"< / code > , and < code > request.content< / code > would return < code > "{'count': 1}"< / code > < / p >
2012-10-05 01:32:43 +04:00
< h2 id = "url-based-accept-headers" > URL based accept headers< / h2 >
< h2 id = "url-based-format-suffixes" > URL based format suffixes< / h2 >
2012-09-02 00:24:33 +04:00
< h2 id = "doesnt-html5-support-put-and-delete-forms" > Doesn't HTML5 support PUT and DELETE forms?< / h2 >
2012-10-05 01:32:43 +04:00
< p > Nope. It was at one point intended to support < code > PUT< / code > and < code > DELETE< / code > forms, but was later < a href = "3" > dropped from the spec< / a > . There remains < a href = "4" > 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 >
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-10-08 15:19:26 +04:00
< script src = "file:///Users/tom/github/django-rest-framework/html//js/jquery-1.8.1-min.js" > < / script >
< script src = "file:///Users/tom/github/django-rest-framework/html//js/prettify-1.0.js" > < / script >
< script src = "file:///Users/tom/github/django-rest-framework/html//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 >
