Adding throttling options

Note

It is advised to go through point 2 of Marking models to create REST APIs and Adding Custom Serializer and have an understanding of passing custom view attributes.

Here, an example of ScopedRateThrottle class is given as other types of classes and options can be managed solely via settings.py.

Let us consider the below model:

models.py
1
2
3
4
5
6
7
from django.db import models

class StudentWithCustomThrottling(models.Model):
    name = models.CharField(max_length=50)

    def __str__(self):
        return "[name={}]".format(self.name)

To add throttling class, the dictionary returned by getParams() method of a ViewParams class must have an entry with key constants.THROTTLE_SCOPE. For example:

view_params.py
1
2
3
4
5
6
7
8
9
from to_rest import constants
from to_rest.utils import ViewParams

class CustomThrottling(ViewParams):

    def getParams():
        temp = dict()
        temp[constants.THROTTLE_SCOPE] = "studentCustomThrottle"
        return temp

Now, let us go back to models.py and see how to provide the throttle scope as viewset attribute.

models.py
1
2
3
4
5
6
7
8
9
from django.db import models
from to_rest.decorators import restifyModel

@restifyModel(customViewParams='CustomThrottling')
class StudentWithCustomThrottling(models.Model):
    name = models.CharField(max_length=50)

    def __str__(self):
        return "[name={}]".format(self.name)

Also, ensure that throttle class and other options are specified in settings.py:

settings.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
...
REST_FRAMEWORK = {
    ...
    'DEFAULT_THROTTLE_CLASSES': [
        'rest_framework.throttling.ScopedRateThrottle',
    ],
    'DEFAULT_THROTTLE_RATES': {
        'studentCustomThrottle': '5/min'
    }
    ...
}