diff options
| author | Tom Christie | 2013-02-15 09:27:37 +0000 |
|---|---|---|
| committer | Tom Christie | 2013-02-15 09:27:37 +0000 |
| commit | 618606888ab34418998d1abfe4668804038ff22f (patch) | |
| tree | cee142bce855671e423fbf447919ddd017599499 /docs/api-guide | |
| parent | 50a9070e469dfc3c1018e9eee8ac9fe8c1a5f552 (diff) | |
| download | django-rest-framework-618606888ab34418998d1abfe4668804038ff22f.tar.bz2 | |
Mention caching. Closes #659.
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/throttling.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index 923593bc..1abd49f4 100644 --- a/docs/api-guide/throttling.md +++ b/docs/api-guide/throttling.md @@ -6,8 +6,6 @@ > > [Twitter API rate limiting response][cite] -[cite]: https://dev.twitter.com/docs/error-codes-responses - Throttling is similar to [permissions], in that it determines if a request should be authorized. Throttles indicate a temporary state, and are used to control the rate of requests that clients can make to an API. As with permissions, multiple throttles may be used. Your API might have a restrictive throttle for unauthenticated requests, and a less restrictive throttle for authenticated requests. @@ -63,6 +61,10 @@ Or, if you're using the `@api_view` decorator with function based views. } return Response(content) +## Setting up the cache + +The throttle classes provided by REST framework use Django's cache backend. You should make sure that you've set appropriate [cache settings][cache-setting]. The default value of `LocMemCache` backend should be okay for simple setups. See Django's [cache documentation][cache-docs] for more details. + --- # API Reference @@ -162,4 +164,7 @@ The following is an example of a rate throttle, that will randomly throttle 1 in def allow_request(self, request, view): return random.randint(1, 10) == 1 +[cite]: https://dev.twitter.com/docs/error-codes-responses [permissions]: permissions.md +[cache-setting]: https://docs.djangoproject.com/en/dev/ref/settings/#caches +[cache-docs]: https://docs.djangoproject.com/en/dev/topics/cache/#setting-up-the-cache
\ No newline at end of file |