2020-06-02 12:07:44 +03:00
|
|
|
<!DOCTYPE html>
|
2018-10-16 15:02:48 +03:00
|
|
|
<html lang="en">
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>Django REST framework</title>
|
2020-07-29 16:56:27 +03:00
|
|
|
<link href="/img/favicon.ico" rel="icon" type="image/x-icon">
|
2020-06-02 12:07:44 +03:00
|
|
|
<link rel="canonical" href="/." />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<meta name="description" content="Django, API, REST">
|
|
|
|
|
<meta name="author" content="Tom Christie">
|
|
|
|
|
|
|
|
|
|
<!-- Le styles -->
|
2020-07-29 16:56:27 +03:00
|
|
|
<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">
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<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;
|
2018-10-16 15:02:48 +03:00
|
|
|
}
|
2020-06-02 12:07:44 +03:00
|
|
|
#sidebarInclude a.promo {
|
|
|
|
|
color: black;
|
2018-10-16 15:02:48 +03:00
|
|
|
}
|
2020-06-02 12:07:44 +03:00
|
|
|
@media (max-width: 767px) {
|
|
|
|
|
div.promo {
|
|
|
|
|
display: none;
|
2018-10-16 15:02:48 +03:00
|
|
|
}
|
2020-06-02 12:07:44 +03:00
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<body onload="prettyPrint()" class="-page">
|
2018-10-16 15:02:48 +03:00
|
|
|
|
2020-06-02 12:07:44 +03:00
|
|
|
<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 disabled" rel="next" >
|
|
|
|
|
Next <i class="icon-arrow-right icon-white"></i>
|
|
|
|
|
</a>
|
|
|
|
|
<a class="repo-link btn btn-inverse btn-small disabled" rel="prev" >
|
|
|
|
|
<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/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">
|
|
|
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
|
|
|
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/tutorials-and-resources/">Tutorials and Resources</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/third-party-packages/">Third Party Packages</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/contributing/">Contributing to REST framework</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/project-management/">Project management</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/release-notes/">Release Notes</a>
|
|
|
|
|
</li>
|
2024-03-16 22:58:38 +03:00
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.15-announcement/">3.15 Announcement</a>
|
|
|
|
|
</li>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
2022-09-22 14:39:11 +03:00
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.14-announcement/">3.14 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2021-12-13 16:11:32 +03:00
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.13-announcement/">3.13 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2020-09-28 12:55:30 +03:00
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.12-announcement/">3.12 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2020-06-02 12:07:44 +03:00
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.11-announcement/">3.11 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.10-announcement/">3.10 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.9-announcement/">3.9 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.8-announcement/">3.8 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.7-announcement/">3.7 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.6-announcement/">3.6 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.5-announcement/">3.5 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.4-announcement/">3.4 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.3-announcement/">3.3 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.2-announcement/">3.2 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.1-announcement/">3.1 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/3.0-announcement/">3.0 Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/kickstarter-announcement/">Kickstarter Announcement</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/mozilla-grant/">Mozilla Grant</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/funding/">Funding</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li >
|
|
|
|
|
<a href="/community/jobs/">Jobs</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<!--/.nav-collapse -->
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2018-10-16 15:02:48 +03:00
|
|
|
</div>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
<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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="promo">
|
2020-07-29 16:56:27 +03:00
|
|
|
|
2020-06-02 12:07:44 +03:00
|
|
|
<div id="sidebarInclude">
|
|
|
|
|
</div>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="main-content" class="span9">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="404-page-not-found" style="text-align: center">404</h1>
|
|
|
|
|
<p style="text-align: center"><strong>Page not found</strong></p>
|
2020-07-29 16:56:27 +03:00
|
|
|
<p style="text-align: center">Try the <a href="/">homepage</a>, or <a href="#mkdocs_search_modal" data-toggle="modal">search the documentation</a>.</p>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|
2018-10-16 15:02:48 +03:00
|
|
|
</footer>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
<!-- 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>
|
2020-07-29 16:56:27 +03:00
|
|
|
<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>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
<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>
|
2018-10-16 15:02:48 +03:00
|
|
|
</body>
|
2020-06-02 12:07:44 +03:00
|
|
|
|
|
|
|
|
</html>
|
