Skip to main content

A Django mixin for API data cache views

Project description

API Data Cache is a simple mixin for Django REST framework to serve database objects to clients using the api_data_cache service.

It is composed of a mixing for list views that processes the request parameters from api_data_cache clients for pagination and filtering.

Installation

  1. Install the package using pip:

    pip install django_api_data_cache
  2. Add ‘api_data_cache’ to your Django project’s INSTALLED_APPS list in the settings.py file:

    INSTALLED_APPS = [
        # ...
        'rest_framework',
        'api_data_cache',
        # ...
    ]

Usage

  1. Import the APIDataCacheListViewMixin into your view module:

    from api_data_cache.mixins import APIDataCacheListViewMixin
  2. Inherit the APIDataCacheListViewMixin in your view class:

    from api_data_cache.mixins import APIDataCacheListViewMixin
    from rest_framework import viewsets
    from .models import YourModel
    from .serializer import YourPartialSerializer
    
    
    class YourListView(APIDataCacheListViewMixin, viewsets.GenericViewSet):
        queryset = YourModel.objects.all()
        serializer_class = YourPartialSerializer
        search_fields = ['field1', 'field2']

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_api_data_cache-0.2.0.tar.gz (4.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page