mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-12-04 23:44:07 +03:00
256 lines
16 KiB
HTML
256 lines
16 KiB
HTML
<!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>
|
|
<link href="http://tomchristie.github.com/django-rest-framework/img/favicon.ico" rel="icon" type="image/x-icon">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="">
|
|
<meta name="author" content="">
|
|
|
|
<!-- Le styles -->
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap-responsive.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/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]-->
|
|
<body onload="prettyPrint()" class="settings-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/restframework2">GitHub</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://tomchristie.github.com/django-rest-framework">Django REST framework</a>
|
|
<div class="nav-collapse collapse">
|
|
<ul class="nav">
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework">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="http://tomchristie.github.com/django-rest-framework/tutorial/quickstart">Quickstart</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization">1 - Serialization</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/2-requests-and-responses">2 - Requests and responses</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/3-class-based-views">3 - Class based views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/4-authentication-permissions-and-throttling">4 - Authentication, permissions and throttling</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/5-relationships-and-hyperlinked-apis">5 - Relationships and hyperlinked APIs</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/6-resource-orientated-projects">6 - Resource orientated projects</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="http://tomchristie.github.com/django-rest-framework/api-guide/requests">Requests</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/responses">Responses</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/views">Views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/generic-views">Generic views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/parsers">Parsers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/renderers">Renderers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/serializers">Serializers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/fields">Serializer fields</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/authentication">Authentication</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/permissions">Permissions</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/throttling">Throttling</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/pagination">Pagination</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/content-negotiation">Content negotiation</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/format-suffixes">Format suffixes</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/reverse">Returning URLs</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/exceptions">Exceptions</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/status-codes">Status codes</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/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="http://tomchristie.github.com/django-rest-framework/topics/csrf">Working with AJAX and CSRF</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/browserhacks">Browser hacks</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/browsable-api">Working with the Browsable API</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/rest-hypermedia-hateoas">REST, Hypermedia & HATEOAS</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/contributing">Contributing to REST framework</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/migration">2.0 Migration Guide</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/changelog">Change Log</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/credits">Credits</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="nav pull-right">
|
|
<!-- TODO
|
|
<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>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="body-content">
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
|
|
<div class="span3">
|
|
<!-- 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>
|
|
-->
|
|
<div id="table-of-contents">
|
|
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
|
|
<li class="main"><a href="#settings">Settings</a></li>
|
|
<li><a href="#accessing-settings">Accessing settings</a></li>
|
|
<li><a href="#default_renderers">DEFAULT_RENDERERS</a></li>
|
|
<li><a href="#default_parsers">DEFAULT_PARSERS</a></li>
|
|
<li><a href="#default_authentication">DEFAULT_AUTHENTICATION</a></li>
|
|
<li><a href="#default_permissions">DEFAULT_PERMISSIONS</a></li>
|
|
<li><a href="#default_throttles">DEFAULT_THROTTLES</a></li>
|
|
<li><a href="#default_model_serializer">DEFAULT_MODEL_SERIALIZER</a></li>
|
|
<li><a href="#default_pagination_serializer">DEFAULT_PAGINATION_SERIALIZER</a></li>
|
|
<li><a href="#format_suffix_kwarg">FORMAT_SUFFIX_KWARG</a></li>
|
|
<li><a href="#unauthenticated_user">UNAUTHENTICATED_USER</a></li>
|
|
<li><a href="#unauthenticated_token">UNAUTHENTICATED_TOKEN</a></li>
|
|
<li><a href="#form_method_override">FORM_METHOD_OVERRIDE</a></li>
|
|
<li><a href="#form_content_override">FORM_CONTENT_OVERRIDE</a></li>
|
|
<li><a href="#form_contenttype_override">FORM_CONTENTTYPE_OVERRIDE</a></li>
|
|
<li><a href="#url_accept_override">URL_ACCEPT_OVERRIDE</a></li>
|
|
<li><a href="#url_format_override">URL_FORMAT_OVERRIDE</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="main-content" class="span9">
|
|
<p><a class="github" href="https://github.com/tomchristie/django-rest-framework/blob/restframework2/rest_framework/settings.py"><span class="label label-info">settings.py</span></a></p>
|
|
<h1 id="settings">Settings</h1>
|
|
<blockquote>
|
|
<p>Namespaces are one honking great idea - let's do more of those!</p>
|
|
<p>— <a href="http://www.python.org/dev/peps/pep-0020/">The Zen of Python</a></p>
|
|
</blockquote>
|
|
<p>Configuration for REST framework is all namespaced inside a single Django setting, named <code>REST_FRAMEWORK</code>.</p>
|
|
<p>For example your project's <code>settings.py</code> file might include something like this:</p>
|
|
<pre class="prettyprint lang-py"><code>REST_FRAMEWORK = {
|
|
'DEFAULT_RENDERERS': (
|
|
'rest_framework.renderers.YAMLRenderer',
|
|
)
|
|
'DEFAULT_PARSERS': (
|
|
'rest_framework.parsers.YAMLParser',
|
|
)
|
|
}
|
|
</code></pre>
|
|
<h2 id="accessing-settings">Accessing settings</h2>
|
|
<p>If you need to access the values of REST framework's API settings in your project,
|
|
you should use the <code>api_settings</code> object. For example.</p>
|
|
<pre class="prettyprint lang-py"><code>from rest_framework.settings import api_settings
|
|
|
|
print api_settings.DEFAULT_AUTHENTICATION
|
|
</code></pre>
|
|
<p>The <code>api_settings</code> object will check for any user-defined settings, and otherwise fallback to the default values. Any setting that uses string import paths to refer to a class will automatically import and return the referenced class, instead of the string literal.</p>
|
|
<h2 id="default_renderers">DEFAULT_RENDERERS</h2>
|
|
<p>A list or tuple of renderer classes, that determines the default set of renderers that may be used when returning a <code>Response</code> object.</p>
|
|
<p>Default:</p>
|
|
<pre class="prettyprint lang-py"><code>(
|
|
'rest_framework.renderers.JSONRenderer',
|
|
'rest_framework.renderers.BrowsableAPIRenderer'
|
|
'rest_framework.renderers.TemplateHTMLRenderer'
|
|
)
|
|
</code></pre>
|
|
<h2 id="default_parsers">DEFAULT_PARSERS</h2>
|
|
<p>A list or tuple of parser classes, that determines the default set of parsers used when accessing the <code>request.DATA</code> property.</p>
|
|
<p>Default:</p>
|
|
<pre class="prettyprint lang-py"><code>(
|
|
'rest_framework.parsers.JSONParser',
|
|
'rest_framework.parsers.FormParser'
|
|
)
|
|
</code></pre>
|
|
<h2 id="default_authentication">DEFAULT_AUTHENTICATION</h2>
|
|
<p>A list or tuple of authentication classes, that determines the default set of authenticators used when accessing the <code>request.user</code> or <code>request.auth</code> properties.</p>
|
|
<p>Default:</p>
|
|
<pre class="prettyprint lang-py"><code>(
|
|
'rest_framework.authentication.SessionAuthentication',
|
|
'rest_framework.authentication.UserBasicAuthentication'
|
|
)
|
|
</code></pre>
|
|
<h2 id="default_permissions">DEFAULT_PERMISSIONS</h2>
|
|
<p>A list or tuple of permission classes, that determines the default set of permissions checked at the start of a view.</p>
|
|
<p>Default: <code>()</code></p>
|
|
<h2 id="default_throttles">DEFAULT_THROTTLES</h2>
|
|
<p>A list or tuple of throttle classes, that determines the default set of throttles checked at the start of a view.</p>
|
|
<p>Default: <code>()</code></p>
|
|
<h2 id="default_model_serializer">DEFAULT_MODEL_SERIALIZER</h2>
|
|
<p><strong>TODO</strong></p>
|
|
<p>Default: <code>rest_framework.serializers.ModelSerializer</code></p>
|
|
<h2 id="default_pagination_serializer">DEFAULT_PAGINATION_SERIALIZER</h2>
|
|
<p><strong>TODO</strong></p>
|
|
<p>Default: <code>rest_framework.pagination.PaginationSerializer</code></p>
|
|
<h2 id="format_suffix_kwarg">FORMAT_SUFFIX_KWARG</h2>
|
|
<p><strong>TODO</strong></p>
|
|
<p>Default: <code>'format'</code></p>
|
|
<h2 id="unauthenticated_user">UNAUTHENTICATED_USER</h2>
|
|
<p>The class that should be used to initialize <code>request.user</code> for unauthenticated requests.</p>
|
|
<p>Default: <code>django.contrib.auth.models.AnonymousUser</code></p>
|
|
<h2 id="unauthenticated_token">UNAUTHENTICATED_TOKEN</h2>
|
|
<p>The class that should be used to initialize <code>request.auth</code> for unauthenticated requests.</p>
|
|
<p>Default: <code>None</code></p>
|
|
<h2 id="form_method_override">FORM_METHOD_OVERRIDE</h2>
|
|
<p>The name of a form field that may be used to override the HTTP method of the form.</p>
|
|
<p>If the value of this setting is <code>None</code> then form method overloading will be disabled.</p>
|
|
<p>Default: <code>'_method'</code></p>
|
|
<h2 id="form_content_override">FORM_CONTENT_OVERRIDE</h2>
|
|
<p>The name of a form field that may be used to override the content of the form payload. Must be used together with <code>FORM_CONTENTTYPE_OVERRIDE</code>.</p>
|
|
<p>If either setting is <code>None</code> then form content overloading will be disabled.</p>
|
|
<p>Default: <code>'_content'</code></p>
|
|
<h2 id="form_contenttype_override">FORM_CONTENTTYPE_OVERRIDE</h2>
|
|
<p>The name of a form field that may be used to override the content type of the form payload. Must be used together with <code>FORM_CONTENT_OVERRIDE</code>.</p>
|
|
<p>If either setting is <code>None</code> then form content overloading will be disabled.</p>
|
|
<p>Default: <code>'_content_type'</code></p>
|
|
<h2 id="url_accept_override">URL_ACCEPT_OVERRIDE</h2>
|
|
<p>The name of a URL parameter that may be used to override the HTTP <code>Accept</code> header.</p>
|
|
<p>If the value of this setting is <code>None</code> then URL accept overloading will be disabled.</p>
|
|
<p>Default: <code>'accept'</code></p>
|
|
<h2 id="url_format_override">URL_FORMAT_OVERRIDE</h2>
|
|
<p>Default: <code>'format'</code></p>
|
|
</div><!--/span-->
|
|
</div><!--/row-->
|
|
</div><!--/.fluid-container-->
|
|
</div><!--/.body content-->
|
|
|
|
<div id="push"></div>
|
|
</div><!--/.wrapper -->
|
|
|
|
<footer class="span12">
|
|
<p>Sponsored by <a href="http://dabapps.com/">DabApps</a>.</a></p>
|
|
</footer>
|
|
|
|
<!-- Le javascript
|
|
================================================== -->
|
|
<!-- Placed at the end of the document so the pages load faster -->
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js"></script>
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/prettify-1.0.js"></script>
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/bootstrap-2.1.1-min.js"></script>
|
|
<script>
|
|
//$('.side-nav').scrollspy()
|
|
var shiftWindow = function() { scrollBy(0, -50) };
|
|
if (location.hash) shiftWindow();
|
|
window.addEventListener("hashchange", shiftWindow);
|
|
|
|
$('.dropdown-menu').on('click touchstart', function(event) {
|
|
event.stopPropagation();
|
|
});
|
|
</script>
|
|
</body></html>
|