2020-06-02 12:07:44 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
< title > Caching - 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/api-guide/caching/" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Caching" >
< 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" >
< 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 = "next" href = "../throttling/" >
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../permissions/" >
< 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" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
< a href = "../../tutorial/quickstart/" > Quickstart< / a >
< / li >
< li >
< a href = "../../tutorial/1-serialization/" > 1 - Serialization< / a >
< / li >
< li >
< a href = "../../tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
< / li >
< li >
< a href = "../../tutorial/3-class-based-views/" > 3 - Class based views< / a >
< / li >
< li >
< a href = "../../tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
< / li >
< li >
< a href = "../../tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
< / li >
< li >
< a href = "../../tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
< a href = "../requests/" > Requests< / a >
< / li >
< li >
< a href = "../responses/" > Responses< / a >
< / li >
< li >
< a href = "../views/" > Views< / a >
< / li >
< li >
< a href = "../generic-views/" > Generic views< / a >
< / li >
< li >
< a href = "../viewsets/" > Viewsets< / a >
< / li >
< li >
< a href = "../routers/" > Routers< / a >
< / li >
< li >
< a href = "../parsers/" > Parsers< / a >
< / li >
< li >
< a href = "../renderers/" > Renderers< / a >
< / li >
< li >
< a href = "../serializers/" > Serializers< / a >
< / li >
< li >
< a href = "../fields/" > Serializer fields< / a >
< / li >
< li >
< a href = "../relations/" > Serializer relations< / a >
< / li >
< li >
< a href = "../validators/" > Validators< / a >
< / li >
< li >
< a href = "../authentication/" > Authentication< / a >
< / li >
< li >
< a href = "../permissions/" > Permissions< / a >
< / li >
< li class = "active" >
< a href = "./" > Caching< / a >
< / li >
< li >
< a href = "../throttling/" > Throttling< / a >
< / li >
< li >
< a href = "../filtering/" > Filtering< / a >
< / li >
< li >
< a href = "../pagination/" > Pagination< / a >
< / li >
< li >
< a href = "../versioning/" > Versioning< / a >
< / li >
< li >
< a href = "../content-negotiation/" > Content negotiation< / a >
< / li >
< li >
< a href = "../metadata/" > Metadata< / a >
< / li >
< li >
< a href = "../schemas/" > Schemas< / a >
< / li >
< li >
< a href = "../format-suffixes/" > Format suffixes< / a >
< / li >
< li >
< a href = "../reverse/" > Returning URLs< / a >
< / li >
< li >
< a href = "../exceptions/" > Exceptions< / a >
< / li >
< li >
< a href = "../status-codes/" > Status codes< / a >
< / li >
< li >
< a href = "../testing/" > Testing< / a >
< / li >
< li >
< a href = "../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 >
2022-09-22 14:39:11 +03:00
< li >
< a href = "../../community/3.14-announcement/" > 3.14 Announcement< / a >
< / li >
2021-12-13 16:11:32 +03:00
< li >
< a href = "../../community/3.13-announcement/" > 3.13 Announcement< / a >
< / li >
2020-09-28 12:55:30 +03:00
< li >
< a href = "../../community/3.12-announcement/" > 3.12 Announcement< / a >
< / li >
2020-06-02 12:07:44 +03:00
< li >
< a href = "../../community/3.11-announcement/" > 3.11 Announcement< / a >
< / li >
< li >
< a href = "../../community/3.10-announcement/" > 3.10 Announcement< / 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 = "#caching" > Caching< / a >
< / li >
< li >
< a href = "#using-cache-with-apiview-and-viewsets" > Using cache with apiview and viewsets< / a >
< / li >
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
< h1 id = "caching" > < a class = "toclink" href = "#caching" > Caching< / a > < / h1 >
< blockquote >
< p > A certain woman had a very sharp consciousness but almost no
memory ... She remembered enough to work, and she worked hard.
- Lydia Davis< / p >
< / blockquote >
< p > Caching in REST Framework works well with the cache utilities
provided in Django.< / p >
< hr / >
< h2 id = "using-cache-with-apiview-and-viewsets" > < a class = "toclink" href = "#using-cache-with-apiview-and-viewsets" > Using cache with apiview and viewsets< / a > < / h2 >
< p > Django provides a < a href = "https://docs.djangoproject.com/en/dev/topics/class-based-views/intro/#decorating-the-class" > < code > method_decorator< / code > < / a > to use
decorators with class based views. This can be used with
2021-03-25 15:24:20 +03:00
other cache decorators such as < a href = "https://docs.djangoproject.com/en/dev/topics/cache/#the-per-view-cache" > < code > cache_page< / code > < / a > ,
< a href = "https://docs.djangoproject.com/en/dev/topics/http/decorators/#django.views.decorators.vary.vary_on_cookie" > < code > vary_on_cookie< / code > < / a > and < a href = "https://docs.djangoproject.com/en/dev/topics/http/decorators/#django.views.decorators.vary.vary_on_headers" > < code > vary_on_headers< / code > < / a > .< / p >
2020-11-06 01:19:01 +03:00
< pre > < code class = "language-python" > from django.utils.decorators import method_decorator
2020-06-02 12:07:44 +03:00
from django.views.decorators.cache import cache_page
2021-03-25 15:24:20 +03:00
from django.views.decorators.vary import vary_on_cookie, vary_on_headers
2020-06-02 12:07:44 +03:00
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework import viewsets
class UserViewSet(viewsets.ViewSet):
2021-03-25 15:24:20 +03:00
# With cookie: cache requested url for each user for 2 hours
2020-06-02 12:07:44 +03:00
@method_decorator(cache_page(60*60*2))
@method_decorator(vary_on_cookie)
def list(self, request, format=None):
content = {
'user_feed': request.user.get_user_feed()
}
return Response(content)
2021-03-25 15:24:20 +03:00
class ProfileView(APIView):
# With auth: cache requested url for each user for 2 hours
@method_decorator(cache_page(60*60*2))
@method_decorator(vary_on_headers(" Authorization" ,))
def get(self, request, format=None):
content = {
'user_feed': request.user.get_user_feed()
}
return Response(content)
2020-06-02 12:07:44 +03:00
2021-03-25 15:24:20 +03:00
class PostView(APIView):
2020-06-02 12:07:44 +03:00
# Cache page for the requested url
@method_decorator(cache_page(60*60*2))
def get(self, request, format=None):
content = {
'title': 'Post title',
'body': 'Post content'
}
return Response(content)
< / code > < / pre >
< p > < strong > NOTE:< / strong > The < a href = "https://docs.djangoproject.com/en/dev/topics/cache/#the-per-view-cache" > < code > cache_page< / code > < / a > decorator only caches the
< code > GET< / code > and < code > HEAD< / code > responses with status 200.< / 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 async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
< 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 = "../../js/theme.js" > < / script >
< script > var base _url = '../..' ; < / script >
< script src = "../../search/main.js" defer > < / 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 >
