Skip to main content

Filter backend for DjangoRestFramework able to parse url parameters

Project description

https://badge.fury.io/py/drf-querystringfilter.png

Filter backend for DjangoRestFramework able to parse url parameters

Supports drf 3.5.x, 3.6.x, 3.7.x, 3.8.x Django 1.10.x, 1.11.x, 2.0.x, python 2.7, 3.6

Documentation

The full documentation is at https://drf-querystringfilter.readthedocs.org.

Basic Usage

class UserSerializer(ModelSerializer):
    class Meta:
        model = User
        exclude = ()


class Users(ListAPIView):
    serializer_class = UserSerializer
    filter_fields = ['username', 'email', 'is_staff', 'date_joined']
    filter_blacklist = None
    filter_backends = (QueryStringFilterBackend,)
    queryset = User.objects.all()

now you can query using…

- /users/?username=sax
- /users/?username__startswith=sa&date_joined__year=2000
- /users/?email__contains=@gmail.com
- /users/?is_staff=true

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

drf-querystringfilter-0.5.0.tar.gz (9.6 kB view details)

Uploaded Source

File details

Details for the file drf-querystringfilter-0.5.0.tar.gz.

File metadata

File hashes

Hashes for drf-querystringfilter-0.5.0.tar.gz
Algorithm Hash digest
SHA256 7398f51c221e5b0d33c77fdac025a9ef347028c4e2faceed92de69b1e36956d7
MD5 467e76dbfb130011b3e37e5ab441e1ec
BLAKE2b-256 5f284535d1c14388b3c8d4580f090e82e45295026164761fecf32b76a8be2e4f

See more details on using hashes here.

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