</li>

<li>

</li>

<p>Generic filters may also present an interface in the browsable API. To do so you should implement a <code>to_html()</code> method which returns a rendered HTML representation of the filter. This method should have the following signature:</p>

<p><code>to_html(self, request, queryset, view)</code></p>

<p>The method should return a rendered HTML string.</p>

<p>You can also make the filter controls available to the schema autogeneration

that REST framework provides, by implementing a <code>get_schema_fields()</code> method. This method should have the following signature:</p>

<p><code>get_schema_fields(self, view)</code></p>

<hr />

<h1 id="custom-pagination-styles"><a class="toclink" href="#custom-pagination-styles">Custom pagination styles</a></h1>

<p>Note that the <code>paginate_queryset</code> method may set state on the pagination instance, that may later be used by the <code>get_paginated_response</code> method.</p>

<h2 id="example"><a class="toclink" href="#example">Example</a></h2>

<h1 id="renderers"><a class="toclink" href="#renderers">Renderers</a></h1>

<p>Before a TemplateResponse instance can be returned to the client, it must be rendered. The rendering process takes the intermediate representation of template and context, and turns it into the final byte stream that can be served to the client.</p>

<p>REST framework includes a number of built in Renderer classes, that allow you to return responses with various media types. There is also support for defining your own custom renderers, which gives you the flexibility to design your own media types.</p>

<h2 id="how-the-renderer-is-determined"><a class="toclink" href="#how-the-renderer-is-determined">How the renderer is determined</a></h2>

Unlike other renderers, the data passed to the <code>Response</code> does not need to be serialized. Also, unlike other renderers, you may want to include a <code>template_name</code> argument when creating the <code>Response</code>.</p>

<p>The TemplateHTMLRenderer will create a <code>RequestContext</code>, using the <code>response.data</code> as the context dict, and determine a template name to use to render the context.</p>

<hr />

<pre><code>response.data = {'results': response.data}

<hr />

<h1 id="schema"><a class="toclink" href="#schema">Schema</a></h1>

<p>A machine-readable [schema] describes what resources are available via the API, what their URLs are, how they are represented and what operations they support.</p>

<p>API schemas are a useful tool that allow for a range of use cases, including

generating reference documentation, or driving dynamic client libraries that

operationIds.</p>

<p>In order to work around this, you can override <code>get_operation_id_base()</code> to

provide a different base for name part of the ID.</p>

<h3 id="autoschema__init__-kwargs"><a class="toclink" href="#autoschema__init__-kwargs"><code>AutoSchema.__init__()</code> kwargs</a></h3>

<p><code>AutoSchema</code> provides a number of <code>__init__()</code> kwargs that can be used for

common customizations, if the default generated values are not appropriate.</p>

<p>This property should be the serializer field class, that is used for relational fields by default.</p>

<p>For <code>ModelSerializer</code> this defaults to <code>PrimaryKeyRelatedField</code>.</p>

<p>For <code>HyperlinkedModelSerializer</code> this defaults to <code>serializers.HyperlinkedRelatedField</code>.</p>

<p>The serializer field class that should be used for any <code>url</code> field on the serializer.</p>

<p>Defaults to <code>serializers.HyperlinkedIdentityField</code></p>

<p>The serializer field class that should be used for any choice fields on the serializer.</p>

<p>Defaults to <code>serializers.ChoiceField</code></p>

<h3 id="the-field_class-and-field_kwargs-api"><a class="toclink" href="#the-field_class-and-field_kwargs-api">The field_class and field_kwargs API</a></h3>

<p>In the case of update operations on <em>nested</em> serializers there's no way of

applying this exclusion, because the instance is not available.</p>

<p>Again, you'll probably want to explicitly remove the validator from the

explicitly, in a <code>.validate()</code> method, or in the view.</p>

<h2 id="debugging-complex-cases"><a class="toclink" href="#debugging-complex-cases">Debugging complex cases</a></h2>

<p>If you're not sure exactly what behavior a <code>ModelSerializer</code> class will

<a href="https://github.com/encode/django-rest-framework">Django REST Framework repo</a> on GitHub.</p>

<p>Then clone your fork. The clone command will look like this, with your GitHub

username instead of YOUR-USERNAME:</p>

<p>See GitHub's <a href="https://help.github.com/articles/fork-a-repo/"><em>Fork a Repo</em></a> Guide for more help.</p>

<h2 id="testing"><a class="toclink" href="#testing">Testing</a></h2>

<p>To run the tests, clone the repository, and then:</p>

<pre><code># Setup the virtual environment

<p>Run using a more concise output style.</p>

<pre><code>./runtests.py -q

<p>Run the tests for a given test case.</p>

<pre><code>./runtests.py MyTestCase

<p>It's also useful to remember that if you have an outstanding pull request then pushing new commits to your GitHub repo will also automatically update the pull requests.</p>

<p>GitHub's documentation for working on pull requests is <a href="https://help.github.com/articles/using-pull-requests">available here</a>.</p>

<p>Always run the tests before submitting pull requests, and ideally run <code>tox</code> in order to check that your modifications are compatible on all supported versions of Python and Django.</p>

<h2 id="managing-compatibility-issues"><a class="toclink" href="#managing-compatibility-issues">Managing compatibility issues</a></h2>

<p>Sometimes, in order to ensure your code works on various different versions of Django, Python or third party libraries, you'll need to run slightly different code depending on the environment. Any code that branches in this way should be isolated into the <code>compat.py</code> module, and should provide a single common interface that the rest of the codebase can use.</p>

<h1 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h1>

<hr />

<h2 id="312x-series"><a class="toclink" href="#312x-series">3.12.x series</a></h2>

<p>Date: 25th March 2021</p>

<li>Properly handle ATOMIC_REQUESTS when multiple database configurations are used. [#7739]</li>

<li>Don't include model properties as automatically generated ordering fields with <code>OrderingFilter</code>. [#7609]</li>

<li>Use <code>deque</code> instead of <code>list</code> for tracking throttling <code>.history</code>. [#7849]</li>

<p>Date: 13th October 2020</p>

<li>Fix issue if <code>rest_framework.authtoken.models</code> is imported, but <code>rest_framework.authtoken</code> is not in INSTALLED_APPS. [#7571]</li>