django_filters与drf_yasg不兼容引发Schema生成警告的解决咨询

一、警告原因分析 #

这个警告是因为drf_yasg无法自动识别自定义查询集逻辑或非标准FilterSet配置，导致无法生成对应的API schema。你的ProductByCategoriesListView虽然没显式用django_filters，但自定义了get_queryset处理查询参数，drf_yasg扫描时解析不了这种自定义逻辑，从而触发警告。

二、具体解决步骤 #

1. 显式配置FilterSet（适配django_filters场景） #

如果视图用到django_filters，先定义明确的filterset_class，替代仅在get_queryset里处理过滤的方式：

import django_filters
from django.db.models import Q

class ProductCategoryFilter(django_filters.FilterSet):
    categories = django_filters.CharFilter(method='filter_by_categories')

    class Meta:
        model = ProductModel
        fields = ['categories']

    def filter_by_categories(self, queryset, name, value):
        categories = value.split(',')
        q_objects = Q()
        for category in categories:
            q_objects |= Q(
                channelproduct_product__productcategory_channelproduct__channel_category__category__icontains=category)
            q_objects |= Q(
                channelproduct_product__productcategory_channelproduct__integration_category__category__icontains=category)
        
        return queryset.filter(q_objects).distinct()

然后在视图中指定该FilterSet：

class ProductByCategoriesListView(TenantListApiViewMixin):
    serializer_class = ProductByCategorySerializer
    filterset_class = ProductCategoryFilter  # 显式关联FilterSet

    @swagger_auto_schema(tags=['Product'])
    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())
        # 转换为业务需要的响应格式
        categories = request.query_params.get('categories', '').split(',')
        response_data = []
        for category in categories:
            products = queryset.filter(
                Q(channelproduct_product__productcategory_channelproduct__channel_category__category__icontains=category) |
                Q(channelproduct_product__productcategory_channelproduct__integration_category__category__icontains=category)
            ).values_list('name', flat=True)
            if products:
                response_data.append({
                    'category': category,
                    'products': list(products)
                })
        
        serializer = self.get_serializer(response_data, many=True)
        return Response(serializer.data)

2. 手动定义schema（适配自定义查询逻辑场景） #

如果不想用FilterSet，直接在swagger_auto_schema里手动声明查询参数和响应结构，让drf_yasg能识别：

from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema

class ProductByCategoriesListView(TenantListApiViewMixin):
    serializer_class = ProductByCategorySerializer

    def get_queryset(self):
        # 保留原查询逻辑
        categories = self.request.query_params.get('categories', '').split(',')
        queryset = []

        for category in categories:
            q_objects = Q()
            q_objects |= Q(
                channelproduct_product__productcategory_channelproduct__channel_category__category__icontains=category)
            q_objects |= Q(
                channelproduct_product__productcategory_channelproduct__integration_category__category__icontains=category)

            products = ProductModel.objects.filter(
                q_objects).distinct().values_list('name', flat=True)

            if products:
                queryset.append({
                    'category': category,
                    'products': list(products)
                })

        return queryset

    @swagger_auto_schema(
        tags=['Product'],
        manual_parameters=[
            openapi.Parameter(
                'categories',
                openapi.IN_QUERY,
                description="逗号分隔的分类名称，例如：Electrónica,Ropa y Accesorios",
                type=openapi.TYPE_STRING
            )
        ],
        responses={200: ProductByCategorySerializer(many=True)}
    )
    def list(self, request, *args, **kwargs):
        queryset = self.get_queryset()
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

3. 临时禁用视图schema生成 #

如果不需要该视图的schema，直接在视图类添加swagger_schema = None关闭生成：

class ProductByCategoriesListView(TenantListApiViewMixin):
    swagger_schema = None  # 禁用当前视图的schema生成
    serializer_class = ProductByCategorySerializer

    # 其余代码保持不变

三、确保视图归入指定标签的注意事项 #

• 确认@swagger_auto_schema(tags=['Product'])装饰器正确应用在list方法上，标签名称拼写无误。
• 如果视图继承的父类也有swagger_auto_schema装饰，可能会覆盖当前设置，需要检查父类代码，或在子类中显式重写方法并指定标签。

内容的提问来源于stack exchange，提问作者JORGE ENRIQUE AMAYA PABON