Skip to content

Commit 107d033

Browse files
authored
Add rest-filters package to filtering docs (#10049)
1 parent 2453fc4 commit 107d033

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

‎docs/api-guide/filtering.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,11 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter]
374374

375375
[drf-url-filter][drf-url-filter] is a simple Django app to apply filters on drf `ModelViewSet`'s `Queryset` in a clean, simple and configurable way. It also supports validations on incoming query params and their values. A beautiful python package `Voluptuous` is being used for validations on the incoming query parameters. The best part about voluptuous is you can define your own validations as per your query params requirements.
376376

377+
### rest-filters
378+
379+
[rest-filters][rest-filters] is a modern, typed replacement for `django-filter` that uses DRF's serializer API. In addition to basic filtering, rest-filters supports filter groups, nested filters and filter defaults. It also includes a constraint system to perform validation across filters with ease. Since it uses the serializer API, you can use your existing serializers or serializer fields to parse query parameters.
380+
381+
377382
[cite]: https://docs.djangoproject.com/en/stable/topics/db/queries/#retrieving-specific-objects-with-filters
378383
[django-filter-docs]: https://django-filter.readthedocs.io/en/latest/index.html
379384
[django-filter-drf-docs]: https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html
@@ -382,6 +387,7 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter]
382387
[django-rest-framework-word-search-filter]: https://github.com/trollknurr/django-rest-framework-word-search-filter
383388
[django-url-filter]: https://github.com/miki725/django-url-filter
384389
[drf-url-filter]: https://github.com/manjitkumar/drf-url-filters
390+
[rest-filters]: https://github.com/realsuayip/rest-filters
385391
[HStoreField]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/fields/#hstorefield
386392
[JSONField]: https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.JSONField
387393
[postgres-search]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/search/

0 commit comments

Comments
 (0)