django_rest_framework_query_tools

Alat Kueri Kerangka Istirahat Django

Paket ini memfasilitasi operasi filter melalui parameter kueri, menyederhanakan proses pemfilteran untuk tampilan Django Rest Framework. Instalasi

Instal melalui pip:

pip install django-rest-framework-query-tools

Contoh Cepat Penggunaan

Misalkan Anda memiliki model Buku dengan bidang seperti penulis, judul, dll. Untuk memfilter Buku menurut penulis menggunakan parameter kueri:

Di views.py Anda, tentukan bidang yang akan difilter menggunakan filter_fields:

django_rest_framework_query_tools.filters.url_fliter import URLFilter class BooksListView(generics.ListAPIView): queryset = Books.objects.all() serializer_class = BookSerializer filter_backends = [URLFilter] filter_fields = ('author',)">

 from rest_framework . views import APIView
from rest_framework import generics
from rest_framework import filters
from django_rest_framework_query_tools . filters . url_fliter import URLFilter

class BooksListView ( generics . ListAPIView ):
    queryset = Books . objects . all ()
    serializer_class = BookSerializer
    filter_backends = [ URLFilter ]
    filter_fields = ( 'author' ,)

Sekarang, Anda dapat melakukan pemfilteran dengan meneruskan parameter kueri:

 /v1/books?author=name

Metode Integrasi 1: Integrasi di views.py

Impor QueryParamsFilter dan gunakan sebagai backend filter:

 from drf_query_tools . filters import QueryParamsFilter

class BooksListView ( generics . ListAPIView ):
    # ...
    filter_backends = [ QueryParamsFilter ]
    filter_fields = ( 'author' ,)
    # ...

Metode 2: Integrasi Global melalui settings.py

Tambahkan QueryParamsFilter ke pengaturan Django Rest Framework Anda:

django_rest_framework_query_tools.filters.url_fliter.URLFilter' ] }">

 REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS' : [
        ' django_rest_framework_query_tools .filters.url_fliter.URLFilter'
    ]
}

Berkontribusi

Jangan ragu untuk berkontribusi dengan membuka terbitan atau mengirimkan permintaan penarikan! Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT - lihat file LISENSI untuk detailnya