encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2026-03-02 11:01:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 40e77f0 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-02-27 13:44:30 +00:00
parent eca330b9eb
commit 86c2c06365
4 changed files with 78 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

138
sitemap.xml
View File

@ -2,278 +2,278 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://www.django-rest-framework.org/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/authentication/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/caching/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/content-negotiation/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/exceptions/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/fields/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/filtering/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/format-suffixes/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/generic-views/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/metadata/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/pagination/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/parsers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/permissions/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/relations/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/renderers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/requests/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/responses/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/reverse/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/routers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/schemas/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/serializers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/settings/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/status-codes/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/testing/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/throttling/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/validators/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/versioning/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/views/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/api-guide/viewsets/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.0-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.1-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.10-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.11-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.12-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.13-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.14-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.15-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.16-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.2-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.3-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.4-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.5-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.6-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.7-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.8-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/3.9-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/contributing/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/jobs/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/kickstarter-announcement/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/mozilla-grant/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/project-management/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/release-notes/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/third-party-packages/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/community/tutorials-and-resources/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/ajax-csrf-cors/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/browsable-api/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/browser-enhancements/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/documenting-your-api/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/html-and-forms/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/internationalization/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/rest-hypermedia-hateoas/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/topics/writable-nested-serializers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/1-serialization/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/2-requests-and-responses/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/3-class-based-views/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/4-authentication-and-permissions/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
<url>
<loc>https://www.django-rest-framework.org/tutorial/quickstart/</loc>
<lastmod>2026-02-26</lastmod>
<lastmod>2026-02-27</lastmod>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.

12
tutorial/1-serialization/index.html
View File

@ -486,7 +486,7 @@
<h2 id="setting-up-a-new-environment"><a class="toclink" href="#setting-up-a-new-environment">Setting up a new environment</a></h2>
<p>Before we do anything else we'll create a new virtual environment, using <a href="https://docs.python.org/3/library/venv.html">venv</a>. This will make sure our package configuration is kept nicely isolated from any other projects we're working on.</p>
<pre><code class="language-bash">python3 -m venv env
source env/bin/activate
source env/bin/activate # On Windows use `env\Scripts\activate`
</code></pre>
<p>Now that we're inside a virtual environment, we can install our package requirements.</p>
<pre><code class="language-bash">pip install django
@ -631,7 +631,11 @@ True
<p>In the same way that Django provides both <code>Form</code> classes and <code>ModelForm</code> classes, REST framework includes both <code>Serializer</code> classes, and <code>ModelSerializer</code> classes.</p>
<p>Let's look at refactoring our serializer using the <code>ModelSerializer</code> class.
Open the file <code>snippets/serializers.py</code> again, and replace the <code>SnippetSerializer</code> class with the following.</p>
<pre><code class="language-python">class SnippetSerializer(serializers.ModelSerializer):
<pre><code class="language-python">from rest_framework import serializers
from snippets.models import Snippet
class SnippetSerializer(serializers.ModelSerializer):
class Meta:
model = Snippet
fields = [&quot;id&quot;, &quot;title&quot;, &quot;code&quot;, &quot;linenos&quot;, &quot;language&quot;, &quot;style&quot;]
@ -744,8 +748,8 @@ Starting Development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
</code></pre>
<p>In another terminal window, we can test the server.</p>
<p>We can test our API using <a href="https://curl.haxx.se/">curl</a> or <a href="https://github.com/httpie/httpie#installation">httpie</a>. Httpie is a user friendly http client that's written in Python. Let's install that.</p>
<p>You can install httpie using pip:</p>
<p>We can test our API using <a href="https://curl.haxx.se/">curl</a> or <a href="https://github.com/httpie/httpie#installation">HTTPie</a>. HTTPie is a user-friendly http client that's written in Python. Let's install that.</p>
<p>You can install HTTPie using pip:</p>
<pre><code class="language-bash">pip install httpie
</code></pre>
<p>Finally, we can get a list of all of the snippets:</p>