2012-10-05 01:32:43 +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 -->
|
|
|
|
|
<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="fields-page">
|
|
|
|
|
|
|
|
|
|
<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/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/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/formoverloading">Browser based PUT, PATCH and DELETE</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/contributing">Contributing to REST framework</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">
|
|
|
|
|
<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="container-fluid">
|
|
|
|
|
<div class="row-fluid">
|
2012-10-05 16:22:18 +04:00
|
|
|
|
2012-10-05 01:32:43 +04:00
|
|
|
<div class="span3">
|
2012-10-05 16:22:18 +04:00
|
|
|
<div id="table-of-contents">
|
|
|
|
|
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
|
2012-10-05 01:32:43 +04:00
|
|
|
<li class="main"><a href="#serializer-fields">Serializer fields</a></li>
|
|
|
|
|
<li class="main"><a href="#generic-fields">Generic Fields</a></li>
|
|
|
|
|
<li><a href="#field">Field</a></li>
|
|
|
|
|
<li><a href="#modelfield">ModelField</a></li>
|
|
|
|
|
<li class="main"><a href="#typed-fields">Typed Fields</a></li>
|
|
|
|
|
<li><a href="#booleanfield">BooleanField</a></li>
|
|
|
|
|
<li><a href="#charfield">CharField</a></li>
|
|
|
|
|
<li><a href="#emailfield">EmailField</a></li>
|
|
|
|
|
<li><a href="#datefield">DateField</a></li>
|
|
|
|
|
<li><a href="#datetimefield">DateTimeField</a></li>
|
|
|
|
|
<li><a href="#integerfield">IntegerField</a></li>
|
|
|
|
|
<li><a href="#floatfield">FloatField</a></li>
|
|
|
|
|
<li class="main"><a href="#relational-fields">Relational Fields</a></li>
|
|
|
|
|
<li><a href="#primarykeyrelatedfield">PrimaryKeyRelatedField</a></li>
|
|
|
|
|
<li><a href="#manyprimarykeyrelatedfield">ManyPrimaryKeyRelatedField</a></li>
|
|
|
|
|
<li><a href="#hyperlinkedrelatedfield">HyperlinkedRelatedField</a></li>
|
|
|
|
|
<li><a href="#manyhyperlinkedrelatedfield">ManyHyperlinkedRelatedField</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/fields.py"><span class="label label-info">fields.py</span></a></p>
|
|
|
|
|
<h1 id="serializer-fields">Serializer fields</h1>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<p>Flat is better than nested.</p>
|
|
|
|
|
<p>— <a href="http://www.python.org/dev/peps/pep-0020/">The Zen of Python</a></p>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<h1 id="generic-fields">Generic Fields</h1>
|
|
|
|
|
<h2 id="field">Field</h2>
|
|
|
|
|
<h2 id="modelfield">ModelField</h2>
|
|
|
|
|
<h1 id="typed-fields">Typed Fields</h1>
|
|
|
|
|
<h2 id="booleanfield">BooleanField</h2>
|
|
|
|
|
<h2 id="charfield">CharField</h2>
|
|
|
|
|
<h2 id="emailfield">EmailField</h2>
|
|
|
|
|
<h2 id="datefield">DateField</h2>
|
|
|
|
|
<h2 id="datetimefield">DateTimeField</h2>
|
|
|
|
|
<h2 id="integerfield">IntegerField</h2>
|
|
|
|
|
<h2 id="floatfield">FloatField</h2>
|
|
|
|
|
<h1 id="relational-fields">Relational Fields</h1>
|
|
|
|
|
<p>Relational fields are used to represent model relationships.</p>
|
|
|
|
|
<h2 id="primarykeyrelatedfield">PrimaryKeyRelatedField</h2>
|
|
|
|
|
<h2 id="manyprimarykeyrelatedfield">ManyPrimaryKeyRelatedField</h2>
|
|
|
|
|
<h2 id="hyperlinkedrelatedfield">HyperlinkedRelatedField</h2>
|
|
|
|
|
<h2 id="manyhyperlinkedrelatedfield">ManyHyperlinkedRelatedField</h2>
|
|
|
|
|
</div><!--/span-->
|
|
|
|
|
</div><!--/row-->
|
2012-10-05 16:22:18 +04:00
|
|
|
|
2012-10-05 01:32:43 +04:00
|
|
|
</div><!--/.fluid-container-->
|
|
|
|
|
|
|
|
|
|
<!-- 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>
|
2012-10-05 16:22:18 +04:00
|
|
|
<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>
|
2012-10-05 01:32:43 +04:00
|
|
|
<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>
|
