<p>Note that, without an explicit <code>default</code>, setting this argument to <code>True</code> will imply a <code>default</code> value of <code>null</code> for serialization output, but does not imply a default for input deserialization.</p>

<p>Defaults to <code>False</code></p>

<h3 id="source"><a class="toclink" href="#source"><code>source</code></a></h3>

<p>The value <code>source='*'</code> has a special meaning, and is used to indicate that the entire object should be passed through to the field. This can be useful for creating nested representations, or for fields which require access to the complete object in order to determine the output representation.</p>

<p>Defaults to the name of the field.</p>

<h3 id="validators"><a class="toclink" href="#validators"><code>validators</code></a></h3>

<li><code>format</code> - A string representing the output format. If not specified, this defaults to the same value as the <code>DATETIME_FORMAT</code> settings key, which will be <code>'iso-8601'</code> unless set. Setting to a format string indicates that <code>to_representation</code> return values should be coerced to string output. Format strings are described below. Setting this value to <code>None</code> indicates that Python <code>datetime</code> objects should be returned by <code>to_representation</code>. In this case the datetime encoding will be determined by the renderer.</li>

<li><code>input_formats</code> - A list of strings representing the input formats which may be used to parse the date. If not specified, the <code>DATETIME_INPUT_FORMATS</code> setting will be used, which defaults to <code>['iso-8601']</code>.</li>

<h4 id="datetimefield-format-strings"><a class="toclink" href="#datetimefield-format-strings"><code>DateTimeField</code> format strings.</a></h4>

<p>Format strings may either be <a href="https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior">Python strftime formats</a> which explicitly specify the format, or the special string <code>'iso-8601'</code>, which indicates that <a href="https://www.w3.org/TR/NOTE-datetime">ISO 8601</a> style datetimes should be used. (eg <code>'2013-01-29T12:34:56.000000Z'</code>)</p>

def get_search_fields(self, view, request):

if request.query_params.get('title_only'):

return ['title']

<p>For more details, see the <a href="https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields">Django documentation</a>.</p>

<hr />

user = self.request.user

return user.accounts.all()

<h4 id="get_objectself"><a class="toclink" href="#get_objectself"><code>get_object(self)</code></a></h4>

<p>Returns an object instance that should be used for detail views. Defaults to using the <code>lookup_field</code> parameter to filter the base queryset.</p>

<p>May be overridden to provide more complex behavior, such as object lookups based on more than one URL kwarg.</p>

<h2 id="drf-proxy-pagination"><a class="toclink" href="#drf-proxy-pagination">drf-proxy-pagination</a></h2>

<p>The <a href="https://github.com/tuffnatty/drf-proxy-pagination"><code>drf-proxy-pagination</code> package</a> includes a <code>ProxyPagination</code> class which allows to choose pagination class with a query parameter.</p>

<h2 id="link-header-pagination"><a class="toclink" href="#link-header-pagination">link-header-pagination</a></h2>

</div> <!--/span-->

<h2 id="how-permissions-are-determined"><a class="toclink" href="#how-permissions-are-determined">How permissions are determined</a></h2>

<p>Permissions in REST framework are always defined as a list of permission classes.</p>

<p>Before running the main body of the view each permission in the list is checked.

<li>The request was successfully authenticated, but permission was denied. <em>&mdash; An HTTP 403 Forbidden response will be returned.</em></li>

<li>The request was not successfully authenticated, and the highest priority authentication class <em>does not</em> use <code>WWW-Authenticate</code> headers. <em>&mdash; An HTTP 403 Forbidden response will be returned.</em></li>

<td>Action: list</td>

<td>global</td>

<td>object-level*</td>

<hr />

<p><strong>Note:</strong> The relational fields are declared in <code>relations.py</code>, but by convention you should import them from the <code>serializers</code> module, using <code>from rest_framework import serializers</code> and refer to fields as <code>serializers.&lt;FieldName&gt;</code>.</p>

<hr />

<h4 id="inspecting-relationships"><a class="toclink" href="#inspecting-relationships">Inspecting relationships.</a></h4>

<p>When using the <code>ModelSerializer</code> class, serializer fields and relationships will be automatically generated for you. Inspecting these automatically generated fields can be a useful tool for determining how to customize the relationship style.</p>

<p>To do so, open the Django shell, using <code>python manage.py shell</code>, then import the serializer class, instantiate it, and print the object representation…</p>

<a href="#allow_empty">allow_empty</a>

</li>

<li>

<a href="#customizing-listserializer-behavior">Customizing ListSerializer behavior</a>

</li>

# .save() will update the existing `comment` instance.

serializer = CommentSerializer(comment, data=data)

<h4 id="passing-additional-attributes-to-save"><a class="toclink" href="#passing-additional-attributes-to-save">Passing additional attributes to <code>.save()</code></a></h4>

<p>Sometimes you'll want your view code to be able to inject additional data at the point of saving the instance. This additional data might include information like the current user, the current time, or anything else that is not part of the request data.</p>

<p>You can do so by including additional keyword arguments when calling <code>.save()</code>. For example:</p>

<p>The following argument can also be passed to a <code>ListSerializer</code> field or a serializer that is passed <code>many=True</code>:</p>

<h3 id="allow_empty"><a class="toclink" href="#allow_empty"><code>allow_empty</code></a></h3>

<p>This is <code>True</code> by default, but can be set to <code>False</code> if you want to disallow empty lists as valid input.</p>

<h3 id="customizing-listserializer-behavior"><a class="toclink" href="#customizing-listserializer-behavior">Customizing <code>ListSerializer</code> behavior</a></h3>

<p>There <em>are</em> a few use cases when you might want to customize the <code>ListSerializer</code> behavior. For example:</p>

fields = kwargs.pop('fields', None)

# Instantiate the superclass normally

if fields is not None:

# Drop any fields that are not specified in the `fields` argument.

<p>If you're using <code>SessionAuthentication</code> then you'll need to include a CSRF token

for any <code>POST</code>, <code>PUT</code>, <code>PATCH</code> or <code>DELETE</code> requests.</p>

<p>You can do so by following the same flow that a JavaScript based client would use.

token in the following request.</p>

<p>For example...</p>

<pre><code>client = RequestsClient()

<p>With careful usage both the <code>RequestsClient</code> and the <code>CoreAPIClient</code> provide

the ability to write test cases that can run either in development, or be run

directly against your staging server or production environment.</p>

a powerful way to validate your live service. Doing so may require some careful

attention to setup and teardown to ensure that the tests run in a way that they

do not directly affect customer data.</p>

<p><strong>Signature:</strong> <code>@api_view(http_method_names=['GET'])</code></p>

<p>The core of this functionality is the <code>api_view</code> decorator, which takes a list of HTTP methods that your view should respond to. For example, this is how you would write a very simple view that just manually returns some data:</p>

<pre><code>from rest_framework.decorators import api_view

@api_view()

def hello_world(request):

if self.action == 'list':

permission_classes = [IsAuthenticated]

else:

return [permission() for permission in permission_classes]

<h2 id="marking-extra-actions-for-routing"><a class="toclink" href="#marking-extra-actions-for-routing">Marking extra actions for routing</a></h2>