2015-10-28 14:35:39 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
< title > 3.3 Announcement - Django REST framework< / title >
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
2018-10-11 16:48:33 +03:00
< link rel = "canonical" href = "https://www.django-rest-framework.org/community/3.3-announcement/" / >
2015-10-28 14:35:39 +03:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, 3.3 Announcement" >
< 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 >
2016-05-26 13:48:39 +03:00
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
2015-10-28 14:35:39 +03:00
color: black;
2016-05-26 13:48:39 +03:00
}
2015-10-28 14:35:39 +03:00
@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" >
2017-05-12 19:15:00 +03:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/encode/django-rest-framework/tree/master" > GitHub< / a >
2018-10-11 16:48:33 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../3.2-announcement/" >
2015-10-28 14:35:39 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2018-10-11 16:48:33 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../3.4-announcement/" >
2015-10-28 14:35:39 +03:00
< 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 >
2018-10-11 16:48:33 +03:00
< a class = "brand" href = "https://www.django-rest-framework.org/" > Django REST framework< / a >
2015-10-28 14:35:39 +03:00
< 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 >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../../tutorial/7-schemas-and-client-libraries/" > 7 - Schemas and client libraries< / a >
< / li >
2015-10-28 14:35:39 +03: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" >
< 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 >
2018-10-11 16:48:33 +03:00
< li >
< a href = "../../api-guide/caching/" > Caching< / a >
< / li >
2015-10-28 14:35:39 +03:00
< 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 >
2016-07-07 11:41:32 +03:00
< li >
< a href = "../../api-guide/schemas/" > Schemas< / a >
< / li >
2015-10-28 14:35:39 +03:00
< 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 >
2018-10-11 16:48:33 +03:00
< li class = "dropdown" >
2015-10-28 14:35:39 +03:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/documenting-your-api/" > Documenting your API< / a >
2015-10-28 14:35:39 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/api-clients/" > API Clients< / a >
2016-07-07 11:41:32 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/internationalization/" > Internationalization< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/html-and-forms/" > HTML & Forms< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/browser-enhancements/" > Browser Enhancements< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/browsable-api/" > The Browsable API< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2015-10-28 14:35:39 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2015-10-28 14:35:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../tutorials-and-resources/" > Tutorials and Resources< / a >
2017-02-25 22:59:44 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../third-party-packages/" > Third Party Packages< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
< a href = "../contributing/" > Contributing to REST framework< / a >
< / li >
< li >
< a href = "../project-management/" > Project management< / a >
< / li >
2017-03-09 17:59:14 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../release-notes/" > Release Notes< / a >
2017-03-09 17:59:14 +03:00
< / li >
2018-10-18 13:50:44 +03:00
< li >
< a href = "../3.9-announcement/" > 3.9 Announcement< / a >
< / li >
2015-10-28 14:35:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.8-announcement/" > 3.8 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.7-announcement/" > 3.7 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.6-announcement/" > 3.6 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< li >
< a href = "../3.5-announcement/" > 3.5 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../3.4-announcement/" > 3.4 Announcement< / a >
< / li >
2018-10-11 16:48:33 +03:00
< li class = "active" >
< a href = "./" > 3.3 Announcement< / a >
2016-10-20 18:31:37 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.2-announcement/" > 3.2 Announcement< / a >
2017-03-09 17:59:14 +03:00
< / li >
2017-10-06 15:06:25 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.1-announcement/" > 3.1 Announcement< / a >
2017-10-06 15:06:25 +03:00
< / li >
2018-04-03 16:54:40 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../3.0-announcement/" > 3.0 Announcement< / a >
2018-04-03 16:54:40 +03:00
< / li >
2017-03-09 17:59:14 +03:00
2015-10-28 14:35:39 +03:00
< li >
< a href = "../kickstarter-announcement/" > Kickstarter Announcement< / a >
< / li >
2016-05-26 13:48:39 +03:00
< li >
< a href = "../mozilla-grant/" > Mozilla Grant< / a >
< / li >
< li >
< a href = "../funding/" > Funding< / a >
< / li >
2015-10-28 14:35:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../jobs/" > Jobs< / a >
2015-10-28 14:35:39 +03:00
< / 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 = "#django-rest-framework-33" > Django REST framework 3.3< / a >
< / li >
< li >
< a href = "#release-notes" > Release notes< / a >
< / li >
< li >
< a href = "#supported-versions" > Supported versions< / a >
< / li >
< li >
< a href = "#deprecations" > Deprecations< / a >
< / li >
2016-05-26 13:48:39 +03:00
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
2015-10-28 14:35:39 +03:00
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
2015-11-04 17:59:23 +03:00
< h1 id = "django-rest-framework-33" > < a class = "toclink" href = "#django-rest-framework-33" > Django REST framework 3.3< / a > < / h1 >
2015-10-28 14:35:39 +03:00
< p > The 3.3 release marks the final work in the Kickstarter funded series. We'd like to offer a final resounding < strong > thank you< / strong > to all our wonderful sponsors and supporters.< / p >
< p > The amount of work that has been achieved as a direct result of the funding is immense. We've added a huge amounts of new functionality, resolved nearly 2,000 tickets, and redesigned & refined large parts of the project.< / p >
< p > In order to continue driving REST framework forward, we'll shortly be announcing a new set of funding plans. Follow < a href = "https://twitter.com/_tomchristie" > @_tomchristie< / a > to keep up to date with these announcements, and be among the first set of sign ups.< / p >
< p > We strongly believe that collaboratively funded software development yields outstanding results for a relatively low investment-per-head. If you or your company use REST framework commercially, then we would strongly urge you to participate in this latest funding drive, and help us continue to build an increasingly polished & professional product.< / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "release-notes" > < a class = "toclink" href = "#release-notes" > Release notes< / a > < / h2 >
2015-10-28 14:35:39 +03:00
< p > Significant new functionality in the 3.3 release includes:< / p >
< ul >
< li > Filters presented as HTML controls in the browsable API.< / li >
2018-10-11 16:48:33 +03:00
< li > A < a href = "../../topics/html-and-forms/" > forms API< / a > , allowing serializers to be rendered as HTML forms.< / li >
2015-10-28 14:35:39 +03:00
< li > Django 1.9 support.< / li >
2018-10-11 16:48:33 +03:00
< li > A < a href = "../../api-guide/fields#jsonfield" > < code > JSONField< / code > serializer field< / a > , corresponding to Django 1.9's Postgres < code > JSONField< / code > model field.< / li >
2017-05-12 19:15:00 +03:00
< li > Browsable API support < a href = "https://github.com/encode/ajax-form" > via AJAX< / a > , rather than server side request overloading.< / li >
2015-10-28 14:35:39 +03:00
< / ul >
< p > < img alt = "Filter Controls" src = "../../img/filter-controls.png" / > < / p >
< p > < em > Example of the new filter controls< / em > < / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "supported-versions" > < a class = "toclink" href = "#supported-versions" > Supported versions< / a > < / h2 >
2015-10-28 14:35:39 +03:00
< p > This release drops support for Django 1.5 and 1.6. Django 1.7, 1.8 or 1.9 are now required.< / p >
< p > This brings our supported versions into line with Django's < a href = "https://www.djangoproject.com/download/#supported-versions" > currently supported versions< / a > < / p >
2015-11-04 17:59:23 +03:00
< h2 id = "deprecations" > < a class = "toclink" href = "#deprecations" > Deprecations< / a > < / h2 >
2015-10-28 14:35:39 +03:00
< p > The AJAX based support for the browsable API means that there are a number of internal cleanups in the < code > request< / code > class. For the vast majority of developers this should largely remain transparent:< / p >
< ul >
2017-05-12 19:15:00 +03:00
< li > To support form based < code > PUT< / code > and < code > DELETE< / code > , or to support form content types such as JSON, you should now use the < a href = "https://github.com/encode/ajax-form" > AJAX forms< / a > javascript library. This replaces the previous 'method and content type overloading' that required significant internal complexity to the request class.< / li >
2018-10-11 16:48:33 +03:00
< li > The < code > accept< / code > query parameter is no longer supported by the default content negotiation class. If you require it then you'll need to < a href = "../../topics/browser-enhancements/#url-based-accept-headers" > use a custom content negotiation class< / a > .< / li >
< li > The custom < code > HTTP_X_HTTP_METHOD_OVERRIDE< / code > header is no longer supported by default. If you require it then you'll need to < a href = "../../topics/browser-enhancements/#http-header-based-method-overriding" > use custom middleware< / a > .< / li >
2015-10-28 14:35:39 +03:00
< / ul >
< p > The following pagination view attributes and settings have been moved into attributes on the pagination class since 3.1. Their usage was formerly deprecated, and has now been removed entirely, in line with the deprecation policy.< / p >
< ul >
< li > < code > view.paginate_by< / code > - Use < code > paginator.page_size< / code > instead.< / li >
< li > < code > view.page_query_param< / code > - Use < code > paginator.page_query_param< / code > instead.< / li >
< li > < code > view.paginate_by_param< / code > - Use < code > paginator.page_size_query_param< / code > instead.< / li >
< li > < code > view.max_paginate_by< / code > - Use < code > paginator.max_page_size< / code > instead.< / li >
< li > < code > settings.PAGINATE_BY< / code > - Use < code > paginator.page_size< / code > instead.< / li >
< li > < code > settings.PAGINATE_BY_PARAM< / code > - Use < code > paginator.page_size_query_param< / code > instead.< / li >
< li > < code > settings.MAX_PAGINATE_BY< / code > - Use < code > paginator.max_page_size< / code > instead.< / li >
< / ul >
< p > The < code > ModelSerializer< / code > and < code > HyperlinkedModelSerializer< / code > classes should now include either a < code > fields< / code > or < code > exclude< / code > option, although the < code > fields = '__all__'< / code > shortcut may be used. Failing to include either of these two options is currently pending deprecation, and will be removed entirely in the 3.5 release. This behavior brings < code > ModelSerializer< / code > more closely in line with Django's < code > ModelForm< / code > behavior.< / 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 >
2019-06-04 14:04:28 +03:00
< script async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
2015-10-28 14:35:39 +03:00
< 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 >
