Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhsiddiqui/dj-rest-filters
A Generic System to validate query params and filter data in Django Rest Framework
https://github.com/mhsiddiqui/dj-rest-filters
django django-rest-framework filter python serializer
Last synced: 4 days ago
JSON representation
A Generic System to validate query params and filter data in Django Rest Framework
- Host: GitHub
- URL: https://github.com/mhsiddiqui/dj-rest-filters
- Owner: mhsiddiqui
- License: mit
- Created: 2022-02-06T18:16:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-20T18:45:09.000Z (about 1 year ago)
- Last Synced: 2024-09-22T10:05:05.222Z (about 2 months ago)
- Topics: django, django-rest-framework, filter, python, serializer
- Language: Python
- Homepage: https://dj-rest-filters.readthedocs.io/en/latest/
- Size: 34.2 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dj-rest-filters
dj-rest-filters is a Django application allowing users to declaratively add dynamic QuerySet filtering from URL parameters. Its uses Django Rest Framework serializers in backend so it provides same syntax as of serializers. You can validate you query parameter in same way as you validate in your serializer and it also provides filtering mechanism against custom query parameters.
[](https://github.com/mhsiddiqui/dj-rest-filters/actions/workflows/test.yml) [](https://codecov.io/gh/mhsiddiqui/dj-rest-filters) [](https://dj-rest-filters.readthedocs.io/en/latest/?badge=latest)
## Installation
> pip install dj-rest-filters
Then add 'djfilters' to your INSTALLED_APPS.
## Usage
### Filtering
```python
from rest_framework import generics
from djfilters.backend import DjFilterBackend
class TodoView(generics.GenericAPIView):
serializer_class = ...
filter_class = TodoFilter
filter_backends = [DjFilterBackend]
queryset = Todo.objects.all()
```
### Validation Only
When queryset is declared, filter will be used to filter that queryset. But when there is not any queryset, filter will just be used to validate the provided query parameters.
```python
from rest_framework import generics
class TodoView(generics.GenericAPIView):
serializer_class = ...
filter_class = MyFilter
```
### Filter Context
Just like serializer context, context can be passed to filter by using `get_filter_context` function like this.
```python
from rest_framework import generics
class TodoView(generics.GenericAPIView):
....
def get_filter_context(self):
context = {'extra_data': 'some_extra_data'}
return context
```
### Accessing Validated Query Params
After query param validation, validated parameters can be accessed using `request.cleaned_args`.
For detailed documentation, click [here](https://dj-rest-filters.readthedocs.io/en/latest/).