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

Deployed e476c22 with MkDocs version: 0.15.3

Browse Source
This commit is contained in:
Tom Christie 2016-07-18 10:23:30 -05:00
parent db3a08472b
commit 38486b2d15
5 changed files with 79 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api-guide/schemas/index.html
View File

@ -572,14 +572,14 @@ permission, throttling or authentication policies to the schema endpoint.</p>
return the schema.</p>
<p><strong>views.py:</strong></p>
<pre><code>from rest_framework.decorators import api_view, renderer_classes
from rest_framework import renderers, schemas
from rest_framework import renderers, response, schemas
generator = schemas.SchemaGenerator(title='Bookings API')
@api_view()
@renderer_classes([renderers.CoreJSONRenderer])
def schema_view(request):
return generator.get_schema()
generator = schemas.SchemaGenerator(title='Bookings API')
return response.Response(generator.get_schema())
</code></pre>
<p><strong>urls.py:</strong></p>
<pre><code>urlpatterns = [
@ -597,7 +597,8 @@ you need to pass the <code>request</code> argument to the <code>get_schema()</co
<pre><code>@api_view()
@renderer_classes([renderers.CoreJSONRenderer])
def schema_view(request):
return generator.get_schema(request=request)
generator = schemas.SchemaGenerator(title='Bookings API')
return response.Response(generator.get_schema(request=request))
</code></pre>
<h2 id="explicit-schema-definition"><a class="toclink" href="#explicit-schema-definition">Explicit schema definition</a></h2>
<p>An alternative to the auto-generated approach is to specify the API schema
@ -606,7 +607,7 @@ little more work, but ensures that you have full control over the schema
representation.</p>
<pre><code>import coreapi
from rest_framework.decorators import api_view, renderer_classes
from rest_framework import renderers
from rest_framework import renderers, response
schema = coreapi.Document(
title='Bookings API',
@ -618,7 +619,7 @@ schema = coreapi.Document(
@api_view()
@renderer_classes([renderers.CoreJSONRenderer])
def schema_view(request):
return schema
return response.Response(schema)
</code></pre>
<h2 id="static-schema-file"><a class="toclink" href="#static-schema-file">Static schema file</a></h2>
<p>A final option is to write your API schema as a static file, using one
@ -668,7 +669,8 @@ generate a schema.</p>
<pre><code>@api_view
@renderer_classes([renderers.CoreJSONRenderer])
def schema_view(request):
return generator.get_schema()
generator = schemas.SchemaGenerator(title='Bookings API')
return Response(generator.get_schema())
</code></pre>
<p>Arguments:</p>
<ul>

2
api-guide/settings/index.html
View File

@ -548,7 +548,7 @@ If set to <code>None</code> then generic filtering is disabled.</p>
<h4 id="allowed_versions"><a class="toclink" href="#allowed_versions">ALLOWED_VERSIONS</a></h4>
<p>If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set.</p>
<p>Default: <code>None</code></p>
<h4 id="version_parameter"><a class="toclink" href="#version_parameter">VERSION_PARAMETER</a></h4>
<h4 id="version_param"><a class="toclink" href="#version_param">VERSION_PARAM</a></h4>
<p>The string that should used for any versioning parameters, such as in the media type or URL query parameters.</p>
<p>Default: <code>'version'</code></p>
<hr />

20
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

112
sitemap.xml
View File

@ -4,7 +4,7 @@
<url>
<loc>http://www.django-rest-framework.org//</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,49 +13,49 @@
<url>
<loc>http://www.django-rest-framework.org//tutorial/quickstart/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/1-serialization/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/3-class-based-views/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/7-schemas-and-client-libraries/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
@ -65,163 +65,163 @@
<url>
<loc>http://www.django-rest-framework.org//api-guide/requests/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/responses/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/views/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/generic-views/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/viewsets/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/routers/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/parsers/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/renderers/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/serializers/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/fields/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/relations/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/validators/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/authentication/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/permissions/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/throttling/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/filtering/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/pagination/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/versioning/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/content-negotiation/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/metadata/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/schemas/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/format-suffixes/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/reverse/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/exceptions/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/status-codes/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/testing/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/settings/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
@ -231,121 +231,121 @@
<url>
<loc>http://www.django-rest-framework.org//topics/documenting-your-api/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/api-clients/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/internationalization/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/html-and-forms/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/browser-enhancements/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/browsable-api/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/third-party-resources/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/contributing/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/project-management/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.0-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.1-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.2-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.3-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.4-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/kickstarter-announcement/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/mozilla-grant/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/funding/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/release-notes/</loc>
<lastmod>2016-07-14</lastmod>
<lastmod>2016-07-18</lastmod>
<changefreq>daily</changefreq>
</url>

6
tutorial/7-schemas-and-client-libraries/index.html
View File

@ -508,7 +508,7 @@ endpoints, in line with how we've set up the permissions on the API.</p>
</code></pre>
<p>Some of the API endpoints require named parameters. For example, to get back
the highlight HTML for a particular snippet we need to provide an id.</p>
<pre><code>$ coreapi action snippets highlight --param pk 1
<pre><code>$ coreapi action snippets highlight --param pk=1
&lt;!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"&gt;
&lt;html&gt;
@ -545,7 +545,7 @@ Pastebin API "http://127.0.0.1:8000/"&gt;
</code></pre>
<p>We're now able to interact with these endpoints. For example, to create a new
snippet:</p>
<pre><code>$ coreapi action snippets create --param title "Example" --param code "print('hello, world')"
<pre><code>$ coreapi action snippets create --param title="Example" --param code="print('hello, world')"
{
"url": "http://127.0.0.1:8000/snippets/7/",
"pk": 7,
@ -559,7 +559,7 @@ snippet:</p>
}
</code></pre>
<p>And to delete a snippet:</p>
<pre><code>$ coreapi action snippets destroy --param pk 7
<pre><code>$ coreapi action snippets destroy --param pk=7
</code></pre>
<p>As well as the command line client, developers can also interact with your
API using client libraries. The Python client library is the first of these