2012-09-02 00:24:33 +04:00
<!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 -->
2012-09-02 00:37:41 +04:00
< 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" >
2012-09-08 11:03:30 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/drf-styles.css" rel = "stylesheet" >
2012-09-02 00:24:33 +04:00
<!-- 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 >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< 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 >
2012-09-02 00:37:41 +04:00
< a class = "brand" href = "http://tomchristie.github.com/django-rest-framework" > Django REST framework< / a >
2012-09-02 00:24:33 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework" > Home< / a > < / li >
2012-09-02 00:24:33 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< 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 >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< 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/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/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/status-codes" > Status codes< / a > < / li >
2012-09-05 16:05:36 +04:00
< 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/settings" > Settings< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< 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 >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/contributing" > Contributing to REST framework< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/credits" > Credits< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
2012-09-08 11:03:30 +04:00
< 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 >
2012-09-02 00:24:33 +04:00
< / div > <!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "container-fluid" >
< div class = "row-fluid" >
2012-09-08 11:03:30 +04:00
< div class = "span3" >
< div id = "table-of-contents" class = "well affix span3" >
< ul class = "nav nav-list side-nav" >
< li class = "main" > < a href = "#views" > Views< / a > < / li >
2012-09-02 00:24:33 +04:00
< li > < a href = "#apiview" > APIView< / a > < / li >
< li > < a href = "#method-handlers" > Method handlers< / a > < / li >
< li > < a href = "#initial(request,-*args,-**kwargs)" > .initial(request, *args, **kwargs)< / a > < / li >
< li > < a href = "#final(request,-response,-*args,-**kwargs)" > .final(request, response, *args, **kwargs)< / a > < / li >
< li > < a href = "#parsers" > .parsers< / a > < / li >
< li > < a href = "#renderers" > .renderers< / a > < / li >
< li > < a href = "#serializer" > .serializer< / a > < / li >
< li > < a href = "#authentication" > .authentication< / a > < / li >
< li > < a href = "#permissions" > .permissions< / a > < / li >
< li > < a href = "#headers" > .headers< / a > < / li >
2012-09-08 11:03:30 +04:00
< / ul >
< / div >
2012-09-02 00:24:33 +04:00
< / div >
2012-09-08 11:03:30 +04:00
< div id = "main-content" class = "span9" >
< blockquote >
2012-09-02 00:24:33 +04:00
< p > Django's class based views are a welcome departure from the old-style views.< / p >
< p > — < a href = "http://reinout.vanrees.org/weblog/2011/08/24/class-based-views-usage.html" > Reinout van Rees< / a > < / p >
< / blockquote >
< h1 id = "views" > Views< / h1 >
< p > REST framework provides a simple < code > APIView< / code > class, built on Django's < code > django.generics.views.View< / code > . The < code > APIView< / code > class ensures five main things:< / p >
< ol >
< li > Any requests inside the view will become < code > Request< / code > instances.< / li >
< li > < code > Request< / code > instances will have their < code > renderers< / code > and < code > authentication< / code > attributes automatically set. < / li >
< li > < code > Response< / code > instances will have their < code > parsers< / code > and < code > serializer< / code > attributes automatically set.< / li >
< li > < code > APIException< / code > exceptions will be caught and return appropriate responses.< / li >
< li > Any permissions provided will be checked prior to passing the request to a handler method.< / li >
< / ol >
< p > Additionally there are a some minor extras, such as providing a default < code > options< / code > handler, setting some common headers on the response prior to return, and providing the useful < code > initial()< / code > and < code > final()< / code > hooks.< / p >
< h2 id = "apiview" > APIView< / h2 >
< h2 id = "method-handlers" > Method handlers< / h2 >
< p > Describe that APIView handles regular .get(), .post(), .put(), .delete() etc...< / p >
< h2 id = "initialrequest-args-kwargs" > .initial(request, < em > args, < / em > *kwargs)< / h2 >
< h2 id = "finalrequest-response-args-kwargs" > .final(request, response, < em > args, < / em > *kwargs)< / h2 >
< h2 id = "parsers" > .parsers< / h2 >
< h2 id = "renderers" > .renderers< / h2 >
< h2 id = "serializer" > .serializer< / h2 >
< h2 id = "authentication" > .authentication< / h2 >
< h2 id = "permissions" > .permissions< / h2 >
< h2 id = "headers" > .headers< / h2 >
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js" > < / script >
2012-09-02 00:37:41 +04:00
< 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 >
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-collapse.js" > < / script >
2012-09-02 00:24:33 +04:00
< script >
2012-09-08 11:03:30 +04:00
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
2012-09-02 00:24:33 +04:00
< / script >
< / body > < / html >
