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 >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "" >
< meta name = "author" content = "" >
<!-- Le styles -->
2012-09-08 23:24:07 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel = "stylesheet" >
2012-09-02 00:37:41 +04:00
< 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" >
2012-09-08 11:03:30 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/drf-styles.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-09-09 19:56:34 +04:00
< body onload = "prettyPrint()" class = "settings" >
2012-09-02 00:24:33 +04:00
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< 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-09-02 00:37:41 +04:00
< a class = "brand" href = "http://tomchristie.github.com/django-rest-framework" > Django REST framework< / a >
2012-09-02 00:24:33 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework" > 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-09-02 00:37:41 +04:00
< 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 >
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-09-02 00:37:41 +04:00
< 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/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/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/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/status-codes" > Status codes< / a > < / li >
2012-09-05 16:05:36 +04:00
< 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/settings" > 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-09-02 00:37:41 +04:00
< 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/formoverloading" > Browser based PUT, PATCH and DELETE< / a > < / li >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/contributing" > Contributing to REST framework< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/credits" > 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 >
< div class = "container-fluid" >
< div class = "row-fluid" >
2012-09-08 11:03:30 +04:00
< div class = "span3" >
< div id = "table-of-contents" class = "well affix span3" >
< ul class = "nav nav-list side-nav" >
< li class = "main" > < a href = "#settings" > Settings< / a > < / li >
2012-09-06 19:47:40 +04:00
< li > < a href = "#accessing-settings" > Accessing settings< / a > < / li >
2012-09-05 16:05:36 +04:00
< 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 >
2012-09-06 00:14:24 +04:00
< li > < a href = "#unauthenticated_user" > UNAUTHENTICATED_USER< / a > < / li >
< li > < a href = "#unauthenticated_token" > UNAUTHENTICATED_TOKEN< / a > < / li >
2012-09-05 16:05:36 +04:00
< 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 >
2012-09-02 00:24:33 +04:00
2012-09-08 11:03:30 +04:00
< / ul >
< / div >
2012-09-02 00:24:33 +04:00
< / div >
2012-09-08 11:03:30 +04:00
< div id = "main-content" class = "span9" >
2012-09-09 01:06:49 +04:00
< p > < a class = "github" href = "https://github.com/tomchristie/django-rest-framework/blob/restframework2/djangorestframework/settings.py" > < span class = "label label-info" > settings.py< / span > < / a > < / p >
< h1 id = "settings" > Settings< / h1 >
2012-09-06 00:14:24 +04:00
< p > Configuration for REST framework is all namespaced inside the < code > API_SETTINGS< / code > setting.< / p >
< p > For example your project's < code > settings.py< / code > file might look like this:< / p >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > API_SETTINGS = {
2012-09-05 16:05:36 +04:00
'DEFAULT_RENDERERS': (
'djangorestframework.renderers.YAMLRenderer',
)
'DEFAULT_PARSERS': (
'djangorestframework.parsers.YAMLParser',
)
}
< / code > < / pre >
2012-09-06 19:47:40 +04:00
< 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 >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > from djangorestframework.settings import api_settings
2012-09-06 19:47:40 +04:00
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 >
2012-09-05 16:05:36 +04:00
< 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 >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > (
2012-09-05 16:05:36 +04:00
'djangorestframework.renderers.JSONRenderer',
'djangorestframework.renderers.DocumentingHTMLRenderer'
'djangorestframework.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 >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > (
2012-09-05 16:05:36 +04:00
'djangorestframework.parsers.JSONParser',
'djangorestframework.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 >
2012-09-06 19:47:40 +04:00
< p > Default:< / p >
2012-09-08 23:24:07 +04:00
< pre class = "prettyprint lang-py" > < code > (
2012-09-05 16:05:36 +04:00
'djangorestframework.authentication.SessionAuthentication',
'djangorestframework.authentication.UserBasicAuthentication'
)
< / code > < / pre >
< h2 id = "default_permissions" > DEFAULT_PERMISSIONS< / h2 >
2012-09-06 00:14:24 +04:00
< p > A list or tuple of permission classes, that determines the default set of permissions checked at the start of a view.< / p >
2012-09-05 16:05:36 +04:00
< p > Default: < code > ()< / code > < / p >
< h2 id = "default_throttles" > DEFAULT_THROTTLES< / h2 >
2012-09-06 00:14:24 +04:00
< p > A list or tuple of throttle classes, that determines the default set of throttles checked at the start of a view.< / p >
2012-09-05 16:05:36 +04:00
< p > Default: < code > ()< / code > < / p >
< h2 id = "default_model_serializer" > DEFAULT_MODEL_SERIALIZER< / h2 >
2012-09-06 19:47:40 +04:00
< p > < strong > TODO< / strong > < / p >
2012-09-05 16:05:36 +04:00
< p > Default: < code > djangorestframework.serializers.ModelSerializer< / code > < / p >
< h2 id = "default_pagination_serializer" > DEFAULT_PAGINATION_SERIALIZER< / h2 >
2012-09-06 19:47:40 +04:00
< p > < strong > TODO< / strong > < / p >
2012-09-05 16:05:36 +04:00
< p > Default: < code > djangorestframework.pagination.PaginationSerializer< / code > < / p >
< h2 id = "format_suffix_kwarg" > FORMAT_SUFFIX_KWARG< / h2 >
2012-09-06 19:47:40 +04:00
< p > < strong > TODO< / strong > < / p >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< p > Default: < code > django.contrib.auth.models.AnonymousUser< / code > < / p >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< h2 id = "form_method_override" > FORM_METHOD_OVERRIDE< / h2 >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< h2 id = "form_content_override" > FORM_CONTENT_OVERRIDE< / h2 >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< h2 id = "form_contenttype_override" > FORM_CONTENTTYPE_OVERRIDE< / h2 >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< h2 id = "url_accept_override" > URL_ACCEPT_OVERRIDE< / h2 >
2012-09-06 00:14:24 +04:00
< 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 >
2012-09-02 00:24:33 +04:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js" > < / script >
2012-09-08 23:24:07 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/prettify.js" > < / script >
2012-09-02 00:37:41 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-dropdown.js" > < / script >
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-scrollspy.js" > < / script >
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-collapse.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-02 00:24:33 +04:00
< / script >
< / body > < / html >
