add drf-yasg compatibility feature 'swagger_fake_view' #321

docs/drf_yasg.rst

@@ -15,3 +15,5 @@ only minor modifications.
 - ``@swagger_serializer_method`` is equivalent to :py:func:`@extend_schema_field <drf_spectacular.utils.extend_schema_field>`.
 
 - ``ref_name`` on Serializer ``Meta`` classes is supported (excluding inlining with ``ref_name=None``)
+
+- ``swagger_fake_view`` is available as attribute on views to signal schema generation

drf_spectacular/generators.py

@@ -92,6 +92,10 @@ def create_view(self, callback, method, request=None):
 
         view = super().create_view(callback, method, request)
 
+        # drf-yasg compatibility feature. makes the view aware that we are running
+        # schema generation and not a real request.
+        view.swagger_fake_view = True
+
         # callback.cls is hosted in urlpatterns and is therefore not an ephemeral modification.
         # restore after view creation so potential revisits have a clean state as basis.
         if override_view:

tests/test_regressions.py

@@ -1009,11 +1009,13 @@ class XViewset(viewsets.ReadOnlyModelViewSet):
         def get_serializer_class(self):
             assert not self.request.user.is_authenticated
             assert self.action in ['retrieve', 'list']
+            assert getattr(self, 'swagger_fake_view', False)  # drf-yasg comp
             return SimpleSerializer
 
         def get_queryset(self):
             assert not self.request.user.is_authenticated
             assert self.request.method == 'GET'
+            assert getattr(self, 'swagger_fake_view', False)  # drf-yasg comp
             return SimpleModel.objects.none()
 
     generate_schema('x', XViewset)