mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-24 02:24:03 +03:00
677 lines
26 KiB
HTML
677 lines
26 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<meta charset="utf-8">
|
||
<title>7 - Schemas and client libraries - Django REST framework</title>
|
||
<link href="../../img/favicon.ico" rel="icon" type="image/x-icon">
|
||
<link rel="canonical" href="https://www.django-rest-framework.org/tutorial/7-schemas-and-client-libraries/" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="Django, API, REST, 7 - Schemas and client libraries">
|
||
<meta name="author" content="Tom Christie">
|
||
|
||
<!-- Le styles -->
|
||
<link href="../../css/prettify.css" rel="stylesheet">
|
||
<link href="../../css/bootstrap.css" rel="stylesheet">
|
||
<link href="../../css/bootstrap-responsive.css" rel="stylesheet">
|
||
<link href="../../css/default.css" rel="stylesheet">
|
||
|
||
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
|
||
<!--[if lt IE 9]>
|
||
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
|
||
<![endif]-->
|
||
|
||
<script type="text/javascript">
|
||
var _gaq = _gaq || [];
|
||
_gaq.push(['_setAccount', 'UA-18852272-2']);
|
||
_gaq.push(['_trackPageview']);
|
||
|
||
(function() {
|
||
var ga = document.createElement('script');
|
||
ga.type = 'text/javascript';
|
||
ga.async = true;
|
||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||
var s = document.getElementsByTagName('script')[0];
|
||
s.parentNode.insertBefore(ga, s);
|
||
})();
|
||
</script>
|
||
|
||
<style>
|
||
#sidebarInclude img {
|
||
margin-bottom: 10px;
|
||
}
|
||
#sidebarInclude a.promo {
|
||
color: black;
|
||
}
|
||
@media (max-width: 767px) {
|
||
div.promo {
|
||
display: none;
|
||
}
|
||
}
|
||
</style>
|
||
</head>
|
||
<body onload="prettyPrint()" class="-page">
|
||
|
||
<div class="wrapper">
|
||
<div class="navbar navbar-inverse navbar-fixed-top">
|
||
<div class="navbar-inner">
|
||
<div class="container-fluid">
|
||
<a class="repo-link btn btn-primary btn-small" href="https://github.com/encode/django-rest-framework/tree/master">GitHub</a>
|
||
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../../api-guide/requests/">
|
||
Next <i class="icon-arrow-right icon-white"></i>
|
||
</a>
|
||
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../6-viewsets-and-routers/">
|
||
<i class="icon-arrow-left icon-white"></i> Previous
|
||
</a>
|
||
<a id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_modal"><i class="icon-search icon-white"></i> Search</a>
|
||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</a>
|
||
<a class="brand" href="https://www.django-rest-framework.org/">Django REST framework</a>
|
||
<div class="nav-collapse collapse">
|
||
|
||
<!-- Main navigation -->
|
||
<ul class="nav navbar-nav">
|
||
|
||
<li >
|
||
<a href="../..">Home</a>
|
||
</li>
|
||
|
||
<li class="dropdown active">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li >
|
||
<a href="../quickstart/">Quickstart</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../1-serialization/">1 - Serialization</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../2-requests-and-responses/">2 - Requests and responses</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../3-class-based-views/">3 - Class based views</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../4-authentication-and-permissions/">4 - Authentication and permissions</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../6-viewsets-and-routers/">6 - Viewsets and routers</a>
|
||
</li>
|
||
|
||
<li class="active" >
|
||
<a href="./">7 - Schemas and client libraries</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li >
|
||
<a href="../../api-guide/requests/">Requests</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/responses/">Responses</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/views/">Views</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/generic-views/">Generic views</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/viewsets/">Viewsets</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/routers/">Routers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/parsers/">Parsers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/renderers/">Renderers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/serializers/">Serializers</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/fields/">Serializer fields</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/relations/">Serializer relations</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/validators/">Validators</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/authentication/">Authentication</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/permissions/">Permissions</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/caching/">Caching</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/throttling/">Throttling</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/filtering/">Filtering</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/pagination/">Pagination</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/versioning/">Versioning</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/content-negotiation/">Content negotiation</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/metadata/">Metadata</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/schemas/">Schemas</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/reverse/">Returning URLs</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/exceptions/">Exceptions</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/status-codes/">Status codes</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/testing/">Testing</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../api-guide/settings/">Settings</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li >
|
||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/api-clients/">API Clients</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/internationalization/">Internationalization</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/ajax-csrf-cors/">AJAX, CSRF & CORS</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/html-and-forms/">HTML & Forms</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/browser-enhancements/">Browser Enhancements</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/browsable-api/">The Browsable API</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../topics/rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
|
||
<li >
|
||
<a href="../../community/tutorials-and-resources/">Tutorials and Resources</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/third-party-packages/">Third Party Packages</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/contributing/">Contributing to REST framework</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/project-management/">Project management</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/release-notes/">Release Notes</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.9-announcement/">3.9 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.8-announcement/">3.8 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.7-announcement/">3.7 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.6-announcement/">3.6 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.5-announcement/">3.5 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.4-announcement/">3.4 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.3-announcement/">3.3 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.2-announcement/">3.2 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.1-announcement/">3.1 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/3.0-announcement/">3.0 Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/kickstarter-announcement/">Kickstarter Announcement</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/mozilla-grant/">Mozilla Grant</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/funding/">Funding</a>
|
||
</li>
|
||
|
||
<li >
|
||
<a href="../../community/jobs/">Jobs</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
<!--/.nav-collapse -->
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="body-content">
|
||
<div class="container-fluid">
|
||
<!-- Search Modal -->
|
||
<div id="mkdocs_search_modal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
||
<h3 id="myModalLabel">Documentation search</h3>
|
||
</div>
|
||
|
||
<div class="modal-body">
|
||
<form role="form" autocomplete="off">
|
||
<div class="form-group">
|
||
<input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query">
|
||
</div>
|
||
</form>
|
||
<div id="mkdocs-search-results"></div>
|
||
</div>
|
||
|
||
<div class="modal-footer">
|
||
<button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span3">
|
||
<div id="table-of-contents">
|
||
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
|
||
|
||
|
||
|
||
<li class="main">
|
||
<a href="#tutorial-7-schemas-client-libraries">Tutorial 7: Schemas & client libraries</a>
|
||
</li>
|
||
|
||
|
||
<li>
|
||
<a href="#core-api">Core API</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="#adding-a-schema">Adding a schema</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="#using-a-command-line-client">Using a command line client</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="#authenticating-our-client">Authenticating our client</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="#reviewing-our-work">Reviewing our work</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="#onwards-and-upwards">Onwards and upwards</a>
|
||
</li>
|
||
|
||
|
||
|
||
<div class="promo">
|
||
<hr/>
|
||
<div id="sidebarInclude">
|
||
</div>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="main-content" class="span9">
|
||
|
||
|
||
|
||
<h1 id="tutorial-7-schemas-client-libraries"><a class="toclink" href="#tutorial-7-schemas-client-libraries">Tutorial 7: Schemas & client libraries</a></h1>
|
||
<p>A schema is a machine-readable document that describes the available API
|
||
endpoints, their URLS, and what operations they support.</p>
|
||
<p>Schemas can be a useful tool for auto-generated documentation, and can also
|
||
be used to drive dynamic client libraries that can interact with the API.</p>
|
||
<h2 id="core-api"><a class="toclink" href="#core-api">Core API</a></h2>
|
||
<p>In order to provide schema support REST framework uses <a href="https://www.coreapi.org/">Core API</a>.</p>
|
||
<p>Core API is a document specification for describing APIs. It is used to provide
|
||
an internal representation format of the available endpoints and possible
|
||
interactions that an API exposes. It can either be used server-side, or
|
||
client-side.</p>
|
||
<p>When used server-side, Core API allows an API to support rendering to a wide
|
||
range of schema or hypermedia formats.</p>
|
||
<p>When used client-side, Core API allows for dynamically driven client libraries
|
||
that can interact with any API that exposes a supported schema or hypermedia
|
||
format.</p>
|
||
<h2 id="adding-a-schema"><a class="toclink" href="#adding-a-schema">Adding a schema</a></h2>
|
||
<p>REST framework supports either explicitly defined schema views, or
|
||
automatically generated schemas. Since we're using viewsets and routers,
|
||
we can simply use the automatic schema generation.</p>
|
||
<p>You'll need to install the <code>coreapi</code> python package in order to include an
|
||
API schema.</p>
|
||
<pre><code>$ pip install coreapi
|
||
</code></pre>
|
||
<p>We can now include a schema for our API, by including an autogenerated schema
|
||
view in our URL configuration.</p>
|
||
<pre><code class="python">from rest_framework.schemas import get_schema_view
|
||
|
||
schema_view = get_schema_view(title='Pastebin API')
|
||
|
||
urlpatterns = [
|
||
path('schema/', schema_view),
|
||
...
|
||
]
|
||
</code></pre>
|
||
|
||
<p>If you visit the <code>/schema/</code> endpoint in a browser you should now see <code>corejson</code>
|
||
representation become available as an option.</p>
|
||
<p><img alt="Schema format" src="../../img/corejson-format.png" /></p>
|
||
<p>We can also request the schema from the command line, by specifying the desired
|
||
content type in the <code>Accept</code> header.</p>
|
||
<pre><code>$ http http://127.0.0.1:8000/schema/ Accept:application/coreapi+json
|
||
HTTP/1.0 200 OK
|
||
Allow: GET, HEAD, OPTIONS
|
||
Content-Type: application/coreapi+json
|
||
|
||
{
|
||
"_meta": {
|
||
"title": "Pastebin API"
|
||
},
|
||
"_type": "document",
|
||
...
|
||
</code></pre>
|
||
<p>The default output style is to use the <a href="https://www.coreapi.org/specification/encoding/#core-json-encoding">Core JSON</a> encoding.</p>
|
||
<p>Other schema formats, such as <a href="https://openapis.org/">Open API</a> (formerly Swagger) are
|
||
also supported.</p>
|
||
<h2 id="using-a-command-line-client"><a class="toclink" href="#using-a-command-line-client">Using a command line client</a></h2>
|
||
<p>Now that our API is exposing a schema endpoint, we can use a dynamic client
|
||
library to interact with the API. To demonstrate this, let's use the
|
||
Core API command line client.</p>
|
||
<p>The command line client is available as the <code>coreapi-cli</code> package:</p>
|
||
<pre><code>$ pip install coreapi-cli
|
||
</code></pre>
|
||
<p>Now check that it is available on the command line...</p>
|
||
<pre><code>$ coreapi
|
||
Usage: coreapi [OPTIONS] COMMAND [ARGS]...
|
||
|
||
Command line client for interacting with CoreAPI services.
|
||
|
||
Visit https://www.coreapi.org/ for more information.
|
||
|
||
Options:
|
||
--version Display the package version number.
|
||
--help Show this message and exit.
|
||
|
||
Commands:
|
||
...
|
||
</code></pre>
|
||
<p>First we'll load the API schema using the command line client.</p>
|
||
<pre><code>$ coreapi get http://127.0.0.1:8000/schema/
|
||
<Pastebin API "http://127.0.0.1:8000/schema/">
|
||
snippets: {
|
||
highlight(id)
|
||
list()
|
||
read(id)
|
||
}
|
||
users: {
|
||
list()
|
||
read(id)
|
||
}
|
||
</code></pre>
|
||
<p>We haven't authenticated yet, so right now we're only able to see the read only
|
||
endpoints, in line with how we've set up the permissions on the API.</p>
|
||
<p>Let's try listing the existing snippets, using the command line client:</p>
|
||
<pre><code>$ coreapi action snippets list
|
||
[
|
||
{
|
||
"url": "http://127.0.0.1:8000/snippets/1/",
|
||
"id": 1,
|
||
"highlight": "http://127.0.0.1:8000/snippets/1/highlight/",
|
||
"owner": "lucy",
|
||
"title": "Example",
|
||
"code": "print('hello, world!')",
|
||
"linenos": true,
|
||
"language": "python",
|
||
"style": "friendly"
|
||
},
|
||
...
|
||
</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 id=1
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
||
|
||
<html>
|
||
<head>
|
||
<title>Example</title>
|
||
...
|
||
</code></pre>
|
||
<h2 id="authenticating-our-client"><a class="toclink" href="#authenticating-our-client">Authenticating our client</a></h2>
|
||
<p>If we want to be able to create, edit and delete snippets, we'll need to
|
||
authenticate as a valid user. In this case we'll just use basic auth.</p>
|
||
<p>Make sure to replace the <code><username></code> and <code><password></code> below with your
|
||
actual username and password.</p>
|
||
<pre><code>$ coreapi credentials add 127.0.0.1 <username>:<password> --auth basic
|
||
Added credentials
|
||
127.0.0.1 "Basic <...>"
|
||
</code></pre>
|
||
<p>Now if we fetch the schema again, we should be able to see the full
|
||
set of available interactions.</p>
|
||
<pre><code>$ coreapi reload
|
||
Pastebin API "http://127.0.0.1:8000/schema/">
|
||
snippets: {
|
||
create(code, [title], [linenos], [language], [style])
|
||
delete(id)
|
||
highlight(id)
|
||
list()
|
||
partial_update(id, [title], [code], [linenos], [language], [style])
|
||
read(id)
|
||
update(id, code, [title], [linenos], [language], [style])
|
||
}
|
||
users: {
|
||
list()
|
||
read(id)
|
||
}
|
||
</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')"
|
||
{
|
||
"url": "http://127.0.0.1:8000/snippets/7/",
|
||
"id": 7,
|
||
"highlight": "http://127.0.0.1:8000/snippets/7/highlight/",
|
||
"owner": "lucy",
|
||
"title": "Example",
|
||
"code": "print('hello, world')",
|
||
"linenos": false,
|
||
"language": "python",
|
||
"style": "friendly"
|
||
}
|
||
</code></pre>
|
||
<p>And to delete a snippet:</p>
|
||
<pre><code>$ coreapi action snippets delete --param id=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
|
||
to be available, and a Javascript client library is planned to be released
|
||
soon.</p>
|
||
<p>For more details on customizing schema generation and using Core API
|
||
client libraries you'll need to refer to the full documentation.</p>
|
||
<h2 id="reviewing-our-work"><a class="toclink" href="#reviewing-our-work">Reviewing our work</a></h2>
|
||
<p>With an incredibly small amount of code, we've now got a complete pastebin Web API, which is fully web browsable, includes a schema-driven client library, and comes complete with authentication, per-object permissions, and multiple renderer formats.</p>
|
||
<p>We've walked through each step of the design process, and seen how if we need to customize anything we can gradually work our way down to simply using regular Django views.</p>
|
||
<p>You can review the final <a href="https://github.com/encode/rest-framework-tutorial">tutorial code</a> on GitHub, or try out a live example in <a href="https://restframework.herokuapp.com/">the sandbox</a>.</p>
|
||
<h2 id="onwards-and-upwards"><a class="toclink" href="#onwards-and-upwards">Onwards and upwards</a></h2>
|
||
<p>We've reached the end of our tutorial. If you want to get more involved in the REST framework project, here are a few places you can start:</p>
|
||
<ul>
|
||
<li>Contribute on <a href="https://github.com/encode/django-rest-framework">GitHub</a> by reviewing and submitting issues, and making pull requests.</li>
|
||
<li>Join the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">REST framework discussion group</a>, and help build the community.</li>
|
||
<li>Follow <a href="https://twitter.com/_tomchristie">the author</a> on Twitter and say hi.</li>
|
||
</ul>
|
||
<p><strong>Now go build awesome things.</strong></p>
|
||
|
||
|
||
</div> <!--/span-->
|
||
</div> <!--/row-->
|
||
</div> <!--/.fluid-container-->
|
||
</div> <!--/.body content-->
|
||
<div id="push"></div>
|
||
</div> <!--/.wrapper -->
|
||
|
||
<footer class="span12">
|
||
<p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.
|
||
</p>
|
||
</footer>
|
||
|
||
<!-- Le javascript
|
||
================================================== -->
|
||
<!-- Placed at the end of the document so the pages load faster -->
|
||
<script src="../../js/jquery-1.8.1-min.js"></script>
|
||
<script src="../../js/prettify-1.0.js"></script>
|
||
<script src="../../js/bootstrap-2.1.1-min.js"></script>
|
||
<script src="https://fund.django-rest-framework.org/sidebar_include.js"></script>
|
||
<script>var base_url = '../..';</script>
|
||
<script src="../../mkdocs/js/require.js"></script>
|
||
<script src="../../js/theme.js"></script>
|
||
|
||
<script>
|
||
var shiftWindow = function() {
|
||
scrollBy(0, -50)
|
||
};
|
||
|
||
if (location.hash) shiftWindow();
|
||
window.addEventListener("hashchange", shiftWindow);
|
||
|
||
$('.dropdown-menu').on('click touchstart', function(event) {
|
||
event.stopPropagation();
|
||
});
|
||
|
||
// Dynamically force sidenav/dropdown to no higher than browser window
|
||
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
|
||
|
||
$(function() {
|
||
$(window).resize(function() {
|
||
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
|
||
});
|
||
});
|
||
</script>
|
||
</body>
|
||
|
||
</html> |