Skip to content Skip to sidebar Skip to footer

How To Use Query Parameters In Django Swagger Documentation?

Let's assume that we have for example such URL - localhost:8000/object?name=STH. Anyone have an idea how can I display object with name equals STH using Django Swagger Documentatio

Solution 1:

I am using djang-filter package that integrates nicely with rest framework and it also has support for swagger docs, you get auto-generated filtering columns for that endpoint in swagger.

from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.generics import ListAPIView

class ObjectList(ListAPIView):
    serializer_class = ObjectSerializer
    queryset = Object.objects.all()
    filter_backends = (DjangoFilterBackend, )
    filter_fields = ('sth', )

Post a Comment for "How To Use Query Parameters In Django Swagger Documentation?"