<p><strong>.media_type</strong>: <code>*/*</code></p>

<h5 id="notes"><a class="toclink" href="#notes">Notes:</a></h5>

<li>Since this parser's <code>media_type</code> matches any content type, <code>FileUploadParser</code> should generally be the only parser set on an API view.</li>

<li><code>FileUploadParser</code> respects Django's standard <code>FILE_UPLOAD_HANDLERS</code> setting, and the <code>request.upload_handlers</code> attribute. See the <a href="https://docs.djangoproject.com/en/stable/topics/http/file-uploads/#upload-handlers">Django documentation</a> for more details.</li>

<p><strong>Note:</strong> when you set new permission classes through class attribute or decorators you're telling the view to ignore the default list set over the <strong>settings.py</strong> file.</p>

<p>Provided they inherit from <code>rest_framework.permissions.BasePermission</code>, permissions can be composed using standard Python bitwise operators. For example, <code>IsAuthenticatedOrReadOnly</code> could be written:</p>

from rest_framework.response import Response

from rest_framework.views import APIView

<h2 id="composed-permissions"><a class="toclink" href="#composed-permissions">Composed Permissions</a></h2>

<p>The <a href="https://github.com/niwibe/djangorestframework-composed-permissions">Composed Permissions</a> package provides a simple way to define complex and multi-depth (with logic operators) permission objects, using small and reusable components.</p>

<h2 id="rest-condition"><a class="toclink" href="#rest-condition">REST Condition</a></h2>

<h2 id="dry-rest-permissions"><a class="toclink" href="#dry-rest-permissions">DRY Rest Permissions</a></h2>

<p>The <a href="https://github.com/Helioscene/dry-rest-permissions">DRY Rest Permissions</a> package provides the ability to define different permissions for individual default and custom actions. This package is made for apps with permissions that are derived from relationships defined in the app's data model. It also supports permission checks being returned to a client app through the API's serializer. Additionally it supports adding permissions to the default and custom list actions to restrict the data they retrieve per user.</p>

<h2 id="django-rest-framework-roles"><a class="toclink" href="#django-rest-framework-roles">Django Rest Framework Roles</a></h2>

<h1 id="serializer-relations"><a class="toclink" href="#serializer-relations">Serializer relations</a></h1>

<p>Relational fields are used to represent model relationships. They can be applied to <code>ForeignKey</code>, <code>ManyToManyField</code> and <code>OneToOneField</code> relationships, as well as to reverse relationships, and custom relationships such as <code>GenericForeignKey</code>.</p>

<hr />

<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>

<pre><code>&gt;&gt;&gt; from myapp.serializers import AccountSerializer

&gt;&gt;&gt; serializer = AccountSerializer()

AccountSerializer():

id = IntegerField(label='ID', read_only=True)

name = CharField(allow_blank=True, max_length=100, required=False)

<p>The default JSON encoding style can be altered using the <code>UNICODE_JSON</code> and <code>COMPACT_JSON</code> settings keys.</p>

<p><strong>.media_type</strong>: <code>application/json</code></p>

<p><strong>.charset</strong>: <code>None</code></p>

<h2 id="templatehtmlrenderer"><a class="toclink" href="#templatehtmlrenderer">TemplateHTMLRenderer</a></h2>

<p>Renders data to HTML, using Django's standard template rendering.

<p>If you're building websites that use <code>TemplateHTMLRenderer</code> along with other renderer classes, you should consider listing <code>TemplateHTMLRenderer</code> as the first class in the <code>renderer_classes</code> list, so that it will be prioritised first even for browsers that send poorly formed <code>ACCEPT:</code> headers.</p>

<p>See the <a href="../../topics/html-and-forms/"><em>HTML &amp; Forms</em> Topic Page</a> for further examples of <code>TemplateHTMLRenderer</code> usage.</p>

<p><strong>.media_type</strong>: <code>text/html</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<p>See also: <code>StaticHTMLRenderer</code></p>

<h2 id="statichtmlrenderer"><a class="toclink" href="#statichtmlrenderer">StaticHTMLRenderer</a></h2>

<p>You can use <code>StaticHTMLRenderer</code> either to return regular HTML pages using REST framework, or to return both HTML and API responses from a single endpoint.</p>

<p><strong>.media_type</strong>: <code>text/html</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<p>See also: <code>TemplateHTMLRenderer</code></p>

<h2 id="browsableapirenderer"><a class="toclink" href="#browsableapirenderer">BrowsableAPIRenderer</a></h2>

<p>Renders data into HTML for the Browsable API:</p>

<p><img alt="The BrowsableAPIRenderer" src="../../img/quickstart.png" /></p>

<p>This renderer will determine which other renderer would have been given highest priority, and use that to display an API style response within the HTML page.</p>

<p><strong>.media_type</strong>: <code>text/html</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<p><strong>.template</strong>: <code>'rest_framework/api.html'</code></p>

<h4 id="customizing-browsableapirenderer"><a class="toclink" href="#customizing-browsableapirenderer">Customizing BrowsableAPIRenderer</a></h4>

model = Account

<p><strong>.media_type</strong>: <code>text/html</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<p><strong>.template</strong>: <code>'rest_framework/admin.html'</code></p>

<h2 id="htmlformrenderer"><a class="toclink" href="#htmlformrenderer">HTMLFormRenderer</a></h2>

<p>For more information see the <a href="../../topics/html-and-forms/">HTML &amp; Forms</a> documentation.</p>

<p><strong>.media_type</strong>: <code>text/html</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<p><strong>.template</strong>: <code>'rest_framework/horizontal/form.html'</code></p>

<h2 id="multipartrenderer"><a class="toclink" href="#multipartrenderer">MultiPartRenderer</a></h2>

<p>This renderer is used for rendering HTML multipart form data. <strong>It is not suitable as a response renderer</strong>, but is instead used for creating test requests, using REST framework's <a href="../testing/">test client and test request factory</a>.</p>

<p><strong>.media_type</strong>: <code>multipart/form-data; boundary=BoUnDaRyStRiNg</code></p>

<p><strong>.charset</strong>: <code>utf-8</code></p>

<hr />

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

<a href="#drf-yasg-yet-another-swagger-generator">drf-yasg - Yet Another Swagger Generator</a>

</li>

<div class="promo">

<p>REST framework includes a few different renderers that you can use for

encoding the API schema.</p>

<li><code>renderers.CoreJSONRenderer</code> - Renders into <a href="https://www.coreapi.org/specification/encoding/#core-json-encoding">Core JSON</a>, a format designed for

use with the <code>coreapi</code> client library.</li>

<h2 id="drf-yasg-yet-another-swagger-generator"><a class="toclink" href="#drf-yasg-yet-another-swagger-generator">drf-yasg - Yet Another Swagger Generator</a></h2>

<p><a href="https://github.com/axnsan12/drf-yasg/">drf-yasg</a> generates <a href="https://openapis.org/">OpenAPI</a> documents suitable for code generation - nested schemas,

named models, response bodies, enum/pattern/min/max validators, form parameters, etc.</p>

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

assert response.status_code == 200

<p>Note that the requests client requires you to pass fully qualified URLs.</p>

<p>The <code>RequestsClient</code> class is useful if you want to write tests that solely interact with the service interface. This is a little stricter than using the standard Django test client, as it means that all interactions should be via the API.</p>

<p>If you're using <code>RequestsClient</code> you'll want to ensure that test setup, and results assertions are performed as regular API calls, rather than interacting with the database models directly. For example, rather than checking that <code>Customer.objects.count() == 3</code> you would list the customers endpoint, and ensure that it contains three records.</p>

<h2 id="headers-authentication"><a class="toclink" href="#headers-authentication">Headers &amp; Authentication</a></h2>

<p><strong>This release is incremental in nature. There <em>are</em> some breaking API changes, and upgrading <em>will</em> require you to read the release notes carefully, but the migration path should otherwise be relatively straightforward.</strong></p>

<p>The difference in quality of the REST framework API and implementation should make writing, maintaining and debugging your application far easier.</p>

<p>3.0 is the first of three releases that have been funded by our recent <a href="https://www.kickstarter.com/projects/tomchristie/django-rest-framework-3">Kickstarter campaign</a>.</p>

<hr />

<h2 id="new-features"><a class="toclink" href="#new-features">New features</a></h2>

<p>Notable features of this new release include:</p>