如何在 drf-yasg 中排除特定端点的显示过滤器

Question

我有一些具有 filterset_fields 和 ordering_fields 属性的 ViewSet。此外，我在那个 ViewSet 中有额外的操作，它用作获取列表的快捷方式并进行一些过滤。我假设在不处理任何其他过滤器（或可能正在订购）选项的情况下使用该额外操作。但在默认情况下，drf-yasg 使用 filterset_fields 和 ordering_fields.

为该额外操作生成参数模式

如何忽略特定端点的 filterset_fields 和 ordering_fields 属性？

Answer 1

经过一些研究，我这样做了：

from drf_yasg.inspectors import SwaggerAutoSchema

class MySwaggerAutoSchema(SwaggerAutoSchema):
    def get_query_parameters(self):
        return []

然后在 swagger_auto_schema 装饰器中使用那个子类来完成我的额外操作 @swagger_auto_schema(auto_schema=MySwaggerAutoSchema)。

但它看起来很野蛮。如果有人有更优雅的解决方案 - 让我知道。

Answer 2

在您的操作装饰器中，将 filterset_fields 和 ordering_fields 设置为一个空列表：

@action(detail=False, methods=['GET'], filterset_fields=[], ordering_fields=[], search_fields=[])

您可以更进一步禁用 filter_backends:

@action(detail=False, methods=['GET'], filter_backends=[])

如何在 drf-yasg 中排除特定端点的显示过滤器

How to exclude show filters for specific endpoint in drf-yasg

django

django-rest-framework

drf-yasg