allow overriding produces/consumes with @swagger_auto_schema decorator (#916)

Co-authored-by: Joel Lefkowitz <[email protected]>

Author: terencehonles

src/drf_yasg/inspectors/view.py

@@ -473,11 +473,13 @@ def get_consumes(self):
 
         :rtype: list[str]
         """
-        return get_consumes(self.get_parser_classes())
+        return self.overrides.get("consumes") or get_consumes(self.get_parser_classes())
 
     def get_produces(self):
         """Return the MIME types this endpoint can produce.
 
         :rtype: list[str]
         """
-        return get_produces(self.get_renderer_classes())
+        return self.overrides.get("produces") or get_produces(
+            self.get_renderer_classes()
+        )

src/drf_yasg/utils.py

@@ -65,6 +65,8 @@ def swagger_auto_schema(
     filter_inspectors=None,
     paginator_inspectors=None,
     tags=None,
+    produces=None,
+    consumes=None,
     **extra_overrides,
 ):
     """Decorate a view method to customize the :class:`.Operation` object generated from
@@ -164,6 +166,8 @@ def swagger_auto_schema(
         :attr:`.ViewInspector.paginator_inspectors` on the
         :class:`.inspectors.SwaggerAutoSchema`
     :param list[str] tags: tags override
+    :param list[str] produces: produces override
+    :param list[str] consumes: consumes override
     :param extra_overrides: extra values that will be saved into the ``overrides`` dict;
         these values will be available in the handling
         :class:`.inspectors.SwaggerAutoSchema` instance via ``self.overrides``
@@ -174,20 +178,22 @@ def decorator(view_method):
             "HTTP method names not allowed here"
         )
         data = {
-            "request_body": request_body,
-            "query_serializer": query_serializer,
+            "consumes": consumes,
+            "deprecated": deprecated,
+            "field_inspectors": list(field_inspectors) if field_inspectors else None,
+            "filter_inspectors": list(filter_inspectors) if filter_inspectors else None,
             "manual_parameters": manual_parameters,
+            "operation_description": operation_description,
             "operation_id": operation_id,
             "operation_summary": operation_summary,
-            "deprecated": deprecated,
-            "operation_description": operation_description,
-            "security": security,
-            "responses": responses,
-            "filter_inspectors": list(filter_inspectors) if filter_inspectors else None,
             "paginator_inspectors": list(paginator_inspectors)
             if paginator_inspectors
             else None,
-            "field_inspectors": list(field_inspectors) if field_inspectors else None,
+            "produces": produces,
+            "query_serializer": query_serializer,
+            "request_body": request_body,
+            "responses": responses,
+            "security": security,
             "tags": list(tags) if tags else None,
         }
         data = filter_none(data)

tests/test_schema_generator.py

@@ -122,6 +122,41 @@ def _basename_or_base_name(basename):
         return {"base_name": basename}
 
 
+@pytest.mark.parametrize(
+    "key,value,override_schema_key",
+    (
+        ("consumes", ["application/vnd.x-override"], None),
+        ("deprecated", True, None),
+        ("operation_description", "description override", "description"),
+        ("operation_id", "id override", "operationId"),
+        ("operation_summary", "summary override", "summary"),
+        ("produces", ["application/vnd.x-override"], None),
+        ("tags", ["tag override"], None),
+    ),
+)
+def test_overrides(key, value, override_schema_key):
+    @swagger_auto_schema(method="get", **{key: value})
+    @api_view()
+    def test_override(request, pk=None):
+        return Response({"message": "Hello, world!"})
+
+    generator = OpenAPISchemaGenerator(
+        info=openapi.Info(title="Test generator", default_version="v1"),
+        version="v2",
+        url="",
+        patterns=[path("test/", test_override)],
+    )
+
+    assert generator.get_schema(None, True)["paths"]["/test/"]["get"] == {
+        "description": "",
+        "operationId": "test_list",
+        "parameters": [],
+        "responses": openapi.Responses({200: openapi.Response("")}),
+        "tags": ["test"],
+        (key if override_schema_key is None else override_schema_key): value,
+    }
+
+
 def test_replaced_serializer():
     class DetailSerializer(serializers.Serializer):
         detail = serializers.CharField()