如何在 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=[])

您可以進一步 go 並禁用filter_backends ：

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