mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-12-04 23:44:07 +03:00
193 lines
13 KiB
HTML
193 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<meta charset="utf-8">
|
||
<title>Django REST framework</title>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="">
|
||
<meta name="author" content="">
|
||
|
||
<!-- Le styles -->
|
||
<link href="http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel="stylesheet">
|
||
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap.css" rel="stylesheet">
|
||
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap-responsive.css" rel="stylesheet">
|
||
<link href="http://tomchristie.github.com/django-rest-framework/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]-->
|
||
<body onload="prettyPrint()" class="generic-views-page">
|
||
|
||
<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/tomchristie/django-rest-framework/tree/restframework2">GitHub</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="http://tomchristie.github.com/django-rest-framework">Django REST framework</a>
|
||
<div class="nav-collapse collapse">
|
||
<ul class="nav">
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework">Home</a></li>
|
||
<li class="dropdown">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization">1 - Serialization</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/2-requests-and-responses">2 - Requests and responses</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/3-class-based-views">3 - Class based views</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/4-authentication-permissions-and-throttling">4 - Authentication, permissions and throttling</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/5-relationships-and-hyperlinked-apis">5 - Relationships and hyperlinked APIs</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/6-resource-orientated-projects">6 - Resource orientated projects</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="http://tomchristie.github.com/django-rest-framework/api-guide/requests">Requests</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/responses">Responses</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/views">Views</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/generic-views">Generic views</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/parsers">Parsers</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/renderers">Renderers</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/serializers">Serializers</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/authentication">Authentication</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/permissions">Permissions</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/throttling">Throttling</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/pagination">Pagination</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/content-negotiation">Content negotiation</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/format-suffixes">Format suffixes</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/reverse">Returning URLs</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/exceptions">Exceptions</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/status-codes">Status codes</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/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="http://tomchristie.github.com/django-rest-framework/topics/csrf">Working with AJAX and CSRF</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/formoverloading">Browser based PUT, PATCH and DELETE</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/browsable-api">Working with the browsable API</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/contributing">Contributing to REST framework</a></li>
|
||
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/credits">Credits</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="nav pull-right">
|
||
<li class="dropdown">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Version: 2.0.0 <b class="caret"></b></a>
|
||
<ul class="dropdown-menu">
|
||
<li><a href="#">Trunk</a></li>
|
||
<li><a href="#">2.0.0</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div><!--/.nav-collapse -->
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container-fluid">
|
||
<div class="row-fluid">
|
||
<div class="span3">
|
||
<div id="table-of-contents" class="well affix span3">
|
||
<ul class="nav nav-list side-nav">
|
||
<li class="main"><a href="#generic-views">Generic views</a></li>
|
||
<li><a href="#example">Example</a></li>
|
||
<li class="main"><a href="#api-reference">API Reference</a></li>
|
||
<li><a href="#listapiview">ListAPIView</a></li>
|
||
<li><a href="#listcreateapiview">ListCreateAPIView</a></li>
|
||
<li><a href="#retrieveapiview">RetrieveAPIView</a></li>
|
||
<li><a href="#retrieveupdatedestroyapiview">RetrieveUpdateDestroyAPIView</a></li>
|
||
<li class="main"><a href="#base-views">Base views</a></li>
|
||
<li><a href="#baseapiview">BaseAPIView</a></li>
|
||
<li><a href="#multipleobjectbaseapiview">MultipleObjectBaseAPIView</a></li>
|
||
<li><a href="#singleobjectbaseapiview">SingleObjectBaseAPIView</a></li>
|
||
<li class="main"><a href="#mixins">Mixins</a></li>
|
||
<li><a href="#listmodelmixin">ListModelMixin</a></li>
|
||
<li><a href="#createmodelmixin">CreateModelMixin</a></li>
|
||
<li><a href="#retrievemodelmixin">RetrieveModelMixin</a></li>
|
||
<li><a href="#updatemodelmixin">UpdateModelMixin</a></li>
|
||
<li><a href="#destroymodelmixin">DestroyModelMixin</a></li>
|
||
<li><a href="#metadatamixin">MetadataMixin</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="main-content" class="span9">
|
||
<p><a class="github" href="https://github.com/tomchristie/django-rest-framework/blob/restframework2/rest_framework/mixins.py"><span class="label label-info">mixins.py</span></a>
|
||
<a class="github" href="https://github.com/tomchristie/django-rest-framework/blob/restframework2/rest_framework/generics.py"><span class="label label-info">generics.py</span></a></p>
|
||
<h1 id="generic-views">Generic views</h1>
|
||
<blockquote>
|
||
<p>Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.</p>
|
||
<p>— <a href="https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views">Django Documentation</a></p>
|
||
</blockquote>
|
||
<p>One of the key benefits of class based views is the way they allow you to compose bits of reusable behaviour. REST framework takes advantage of this by providing a number of pre-built views that provide for commonly used patterns. </p>
|
||
<h2 id="example">Example</h2>
|
||
<p>...</p>
|
||
<hr />
|
||
<h1 id="api-reference">API Reference</h1>
|
||
<h2 id="listapiview">ListAPIView</h2>
|
||
<p>Used for read-write endpoints to represent a collection of model instances.</p>
|
||
<p>Provides a <code>get</code> method handler.</p>
|
||
<h2 id="listcreateapiview">ListCreateAPIView</h2>
|
||
<p>Used for read-write endpoints to represent a collection of model instances.</p>
|
||
<p>Provides <code>get</code> and <code>post</code> method handlers.</p>
|
||
<h2 id="retrieveapiview">RetrieveAPIView</h2>
|
||
<p>Used for read-only endpoints to represent a single model instance.</p>
|
||
<p>Provides a <code>get</code> method handler.</p>
|
||
<h2 id="retrieveupdatedestroyapiview">RetrieveUpdateDestroyAPIView</h2>
|
||
<p>Used for read-write endpoints to represent a single model instance.</p>
|
||
<p>Provides <code>get</code>, <code>put</code> and <code>delete</code> method handlers.</p>
|
||
<hr />
|
||
<h1 id="base-views">Base views</h1>
|
||
<h2 id="baseapiview">BaseAPIView</h2>
|
||
<p>Extends REST framework's <code>APIView</code> class, adding support for serialization of model instances and model querysets.</p>
|
||
<h2 id="multipleobjectbaseapiview">MultipleObjectBaseAPIView</h2>
|
||
<p>Provides a base view for acting on a single object, by combining REST framework's <code>APIView</code>, and Django's <a href="https://docs.djangoproject.com/en/dev/ref/class-based-views/mixins-multiple-object/">MultipleObjectMixin</a>.</p>
|
||
<p><strong>See also:</strong> ccbv.co.uk documentation for <a href="http://ccbv.co.uk/projects/Django/1.4/django.views.generic.list/MultipleObjectMixin/">MultipleObjectMixin</a>.</p>
|
||
<h2 id="singleobjectbaseapiview">SingleObjectBaseAPIView</h2>
|
||
<p>Provides a base view for acting on a single object, by combining REST framework's <code>APIView</code>, and Django's <a href="https://docs.djangoproject.com/en/dev/ref/class-based-views/mixins-single-object/">SingleObjectMixin</a>.</p>
|
||
<p><strong>See also:</strong> ccbv.co.uk documentation for <a href="http://ccbv.co.uk/projects/Django/1.4/django.views.generic.detail/SingleObjectMixin/">SingleObjectMixin</a>.</p>
|
||
<hr />
|
||
<h1 id="mixins">Mixins</h1>
|
||
<p>The mixin classes provide the actions that are used </p>
|
||
<h2 id="listmodelmixin">ListModelMixin</h2>
|
||
<p>Provides a <code>.list(request, *args, **kwargs)</code> method, that implements listing a queryset.</p>
|
||
<h2 id="createmodelmixin">CreateModelMixin</h2>
|
||
<p>Provides a <code>.create(request, *args, **kwargs)</code> method, that implements creating and saving a new model instance.</p>
|
||
<h2 id="retrievemodelmixin">RetrieveModelMixin</h2>
|
||
<p>Provides a <code>.retrieve(request, *args, **kwargs)</code> method, that implements returning an existing model instance in a response.</p>
|
||
<h2 id="updatemodelmixin">UpdateModelMixin</h2>
|
||
<p>Provides a <code>.update(request, *args, **kwargs)</code> method, that implements updating and saving an existing model instance.</p>
|
||
<h2 id="destroymodelmixin">DestroyModelMixin</h2>
|
||
<p>Provides a <code>.destroy(request, *args, **kwargs)</code> method, that implements deletion of an existing model instance.</p>
|
||
<h2 id="metadatamixin">MetadataMixin</h2>
|
||
<p>Provides a <code>.metadata(request, *args, **kwargs)</code> method, that returns a response containing metadata about the view.</p>
|
||
</div><!--/span-->
|
||
</div><!--/row-->
|
||
</div><!--/.fluid-container-->
|
||
|
||
<!-- Le javascript
|
||
================================================== -->
|
||
<!-- Placed at the end of the document so the pages load faster -->
|
||
<script src="http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js"></script>
|
||
<script src="http://tomchristie.github.com/django-rest-framework/js/prettify.js"></script>
|
||
<script src="http://tomchristie.github.com/django-rest-framework/js/bootstrap-dropdown.js"></script>
|
||
<script src="http://tomchristie.github.com/django-rest-framework/js/bootstrap-scrollspy.js"></script>
|
||
<script src="http://tomchristie.github.com/django-rest-framework/js/bootstrap-collapse.js"></script>
|
||
<script>
|
||
//$('.side-nav').scrollspy()
|
||
var shiftWindow = function() { scrollBy(0, -50) };
|
||
if (location.hash) shiftWindow();
|
||
window.addEventListener("hashchange", shiftWindow);
|
||
|
||
$('.dropdown-menu').on('click touchstart', function(event) {
|
||
event.stopPropagation();
|
||
});
|
||
</script>
|
||
</body></html>
|