2020-06-02 12:07:44 +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.10 Announcement - Django REST framework< / title >
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "https://www.django-rest-framework.org/community/3.10-announcement/" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, 3.10 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" >
< 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 >
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
color: black;
}
@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/encode/django-rest-framework/tree/master" > GitHub< / a >
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../3.9-announcement/" >
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../3.11-announcement/" >
< 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 = "https://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/caching/" > Caching< / 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/schemas/" > Schemas< / 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" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
< a href = "../../topics/documenting-your-api/" > Documenting your API< / a >
< / li >
< li >
< a href = "../../topics/api-clients/" > API Clients< / a >
< / li >
< li >
< a href = "../../topics/internationalization/" > Internationalization< / a >
< / li >
< li >
< a href = "../../topics/ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
< / li >
< li >
< a href = "../../topics/html-and-forms/" > HTML & Forms< / a >
< / li >
< li >
< a href = "../../topics/browser-enhancements/" > Browser Enhancements< / a >
< / li >
< li >
< a href = "../../topics/browsable-api/" > The Browsable API< / a >
< / li >
< li >
< a href = "../../topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
< a href = "../tutorials-and-resources/" > Tutorials and Resources< / a >
< / li >
< li >
< a href = "../third-party-packages/" > Third Party Packages< / a >
< / li >
< li >
< a href = "../contributing/" > Contributing to REST framework< / a >
< / li >
< li >
< a href = "../project-management/" > Project management< / a >
< / li >
< li >
< a href = "../release-notes/" > Release Notes< / a >
< / li >
2020-09-28 12:55:30 +03:00
< li >
< a href = "../3.12-announcement/" > 3.12 Announcement< / a >
< / li >
2020-06-02 12:07:44 +03:00
< li >
< a href = "../3.11-announcement/" > 3.11 Announcement< / a >
< / li >
< li class = "active" >
< a href = "./" > 3.10 Announcement< / a >
< / li >
< li >
< a href = "../3.9-announcement/" > 3.9 Announcement< / a >
< / li >
< li >
< a href = "../3.8-announcement/" > 3.8 Announcement< / a >
< / li >
< li >
< a href = "../3.7-announcement/" > 3.7 Announcement< / a >
< / li >
< li >
< a href = "../3.6-announcement/" > 3.6 Announcement< / a >
< / li >
< li >
< a href = "../3.5-announcement/" > 3.5 Announcement< / a >
< / li >
< li >
< a href = "../3.4-announcement/" > 3.4 Announcement< / a >
< / li >
< li >
< a href = "../3.3-announcement/" > 3.3 Announcement< / a >
< / li >
< li >
< a href = "../3.2-announcement/" > 3.2 Announcement< / a >
< / li >
< li >
< a href = "../3.1-announcement/" > 3.1 Announcement< / a >
< / li >
< li >
< a href = "../3.0-announcement/" > 3.0 Announcement< / a >
< / li >
< li >
< a href = "../kickstarter-announcement/" > Kickstarter Announcement< / a >
< / li >
< li >
< a href = "../mozilla-grant/" > Mozilla Grant< / a >
< / li >
< li >
< a href = "../funding/" > Funding< / a >
< / li >
< li >
< a href = "../jobs/" > Jobs< / 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 = "#django-rest-framework-310" > Django REST framework 3.10< / a >
< / li >
< li >
< a href = "#openapi-schema-generation" > OpenAPI Schema Generation< / a >
< / li >
< li >
< a href = "#continuing-to-use-coreapi" > Continuing to use CoreAPI< / a >
< / li >
< li >
< a href = "#openapi-quickstart" > OpenAPI Quickstart< / a >
< / li >
< li >
< a href = "#feature-roadmap" > Feature Roadmap< / a >
< / li >
< li >
< a href = "#funding" > Funding< / a >
< / li >
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
< style >
.promo li a {
float: left;
width: 130px;
height: 20px;
text-align: center;
margin: 10px 30px;
padding: 150px 0 0 0;
background-position: 0 50%;
background-size: 130px auto;
background-repeat: no-repeat;
font-size: 120%;
color: black;
}
.promo li {
list-style: none;
}
< / style >
< h1 id = "django-rest-framework-310" > < a class = "toclink" href = "#django-rest-framework-310" > Django REST framework 3.10< / a > < / h1 >
< p > The 3.10 release drops support for Python 2.< / p >
< ul >
< li > Our supported Python versions are now: 3.5, 3.6, and 3.7.< / li >
< li > Our supported Django versions are now: 1.11, 2.0, 2.1, and 2.2.< / li >
< / ul >
< h2 id = "openapi-schema-generation" > < a class = "toclink" href = "#openapi-schema-generation" > OpenAPI Schema Generation< / a > < / h2 >
< p > Since we first introduced schema support in Django REST Framework 3.5, OpenAPI has emerged as the widely adopted standard for modeling Web APIs.< / p >
< p > This release begins the deprecation process for the CoreAPI based schema generation, and introduces OpenAPI schema generation in its place.< / p >
< hr / >
< h2 id = "continuing-to-use-coreapi" > < a class = "toclink" href = "#continuing-to-use-coreapi" > Continuing to use CoreAPI< / a > < / h2 >
< p > If you're currently using the CoreAPI schemas, you'll need to make sure to
update your REST framework settings to include < code > DEFAULT_SCHEMA_CLASS< / code > explicitly.< / p >
< p > < strong > settings.py< / strong > :< / p >
< pre > < code class = "python" > REST_FRAMEWORK = {
...
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
}
< / code > < / pre >
< p > You'll still be able to keep using CoreAPI schemas, API docs, and client for the
foreseeable future. We'll aim to ensure that the CoreAPI schema generator remains
available as a third party package, even once it has eventually been removed
from REST framework, scheduled for version 3.12.< / p >
< p > We have removed the old documentation for the CoreAPI based schema generation.
You may view the < a href = "https://github.com/encode/django-rest-framework/blob/master/docs/coreapi/index.md" > Legacy CoreAPI documentation here< / a > .< / p >
< hr / >
< h2 id = "openapi-quickstart" > < a class = "toclink" href = "#openapi-quickstart" > OpenAPI Quickstart< / a > < / h2 >
< p > You can generate a static OpenAPI schema, using the < code > generateschema< / code > management
command.< / p >
< p > Alternately, to have the project serve an API schema, use the < code > get_schema_view()< / code >
shortcut.< / p >
< p > In your < code > urls.py< / code > :< / p >
< pre > < code class = "python" > from rest_framework.schemas import get_schema_view
urlpatterns = [
# ...
# Use the `get_schema_view()` helper to add a `SchemaView` to project URLs.
# * `title` and `description` parameters are passed to `SchemaGenerator`.
# * Provide view name for use with `reverse()`.
path('openapi', get_schema_view(
title=" Your Project" ,
description=" API for all things …"
), name='openapi-schema'),
# ...
]
< / code > < / pre >
< h3 id = "customization" > < a class = "toclink" href = "#customization" > Customization< / a > < / h3 >
< p > For customizations that you want to apply across the entire API, you can subclass < code > rest_framework.schemas.openapi.SchemaGenerator< / code > and provide it as an argument
to the < code > generateschema< / code > command or < code > get_schema_view()< / code > helper function.< / p >
< p > For specific per-view customizations, you can subclass < code > AutoSchema< / code > ,
making sure to set < code > schema = < YourCustomClass> < / code > on the view.< / p >
< p > For more details, see the < a href = "../../api-guide/schemas/" > API Schema documentation< / a > .< / p >
< h3 id = "api-documentation" > < a class = "toclink" href = "#api-documentation" > API Documentation< / a > < / h3 >
< p > There are some great third party options for documenting your API, based on the
OpenAPI schema.< / p >
< p > See the < a href = "../../topics/documenting-your-api/" > Documenting you API< / a > section for more details.< / p >
< hr / >
< h2 id = "feature-roadmap" > < a class = "toclink" href = "#feature-roadmap" > Feature Roadmap< / a > < / h2 >
< p > Given that our OpenAPI schema generation is a new feature, it's likely that there
will still be some iterative improvements for us to make. There will be two
main cases here:< / p >
< ul >
< li > Expanding the supported range of OpenAPI schemas that are generated by default.< / li >
< li > Improving the ability for developers to customize the output.< / li >
< / ul >
< p > We'll aim to bring the first type of change quickly in point releases. For the
second kind we'd like to adopt a slower approach, to make sure we keep the API
simple, and as widely applicable as possible, before we bring in API changes.< / p >
< p > It's also possible that we'll end up implementing API documentation and API client
tooling that are driven by the OpenAPI schema. The < code > apistar< / code > project has a
significant amount of work towards this. However, if we do so, we'll plan
on keeping any tooling outside of the core framework.< / p >
< hr / >
< h2 id = "funding" > < a class = "toclink" href = "#funding" > Funding< / a > < / h2 >
< p > REST framework is a < em > collaboratively funded project< / em > . If you use
REST framework commercially we strongly encourage you to invest in its
continued development by < strong > < a href = "../funding/" > signing up for a paid plan< / a > < / strong > .< / p >
< p > < em > Every single sign-up helps us make REST framework long-term financially sustainable.< / em > < / p >
< ul class = "premium-promo promo" >
< li > < a href = "https://getsentry.com/welcome/" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)" > Sentry< / a > < / li >
< li > < a href = "https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)" > Stream< / a > < / li >
< li > < a href = "https://software.esg-usa.com" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)" > ESG< / a > < / li >
< li > < a href = "https://rollbar.com" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)" > Rollbar< / a > < / li >
< li > < a href = "https://cadre.com" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)" > Cadre< / a > < / li >
< li > < a href = "https://hubs.ly/H0f30Lf0" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)" > Kloudless< / a > < / li >
< li > < a href = "https://lightsonsoftware.com" style = "background-image: url(https://fund-rest-framework.s3.amazonaws.com/lightson-dark.png)" > Lights On Software< / a > < / li >
< / ul >
< div style = "clear: both; padding-bottom: 20px;" > < / div >
< p > < em > Many thanks to all our < a href = "https://fund.django-rest-framework.org/topics/funding/#our-sponsors" > wonderful sponsors< / a > , and in particular to our premium backers, < a href = "https://getsentry.com/welcome/" > Sentry< / a > , < a href = "https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf" > Stream< / a > , < a href = "https://software.esg-usa.com/" > ESG< / a > , < a href = "https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial" > Rollbar< / a > , < a href = "https://cadre.com" > Cadre< / a > , < a href = "https://hubs.ly/H0f30Lf0" > Kloudless< / a > , and < a href = "https://lightsonsoftware.com" > Lights On Software< / a > .< / em > < / 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 async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
< 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 src = "../../js/theme.js" > < / script >
< script > var base _url = '../..' ; < / script >
< script src = "../../search/main.js" defer > < / 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 >
