get component name from meta attribute or class name

Author: gnuletik

rest_framework/schemas/openapi.py

@@ -1,3 +1,4 @@
+import re
 import warnings
 from operator import attrgetter
 from urllib.parse import urljoin
@@ -109,20 +110,33 @@ def get_operation(self, path, method):
 
         return operation
 
+    def _get_serializer_component_name(self, serializer):
+        if not hasattr(serializer, 'Meta'):
+            return None
+
+        if hasattr(serializer.Meta, 'schema_component_name'):
+            return serializer.Meta.schema_component_name
+
+        # If the serializer has no Meta.schema_component_name, we use
+        # the serializer's class name as the component name.
+        component_name = serializer.__class__.__name__
+        # We remove the "serializer" string from the class name.
+        pattern = re.compile("serializer", re.IGNORECASE)
+        return pattern.sub("", component_name)
+
     def get_components(self, path, method):
         serializer = self._get_serializer(path, method)
 
         if not isinstance(serializer, serializers.Serializer):
             return None
 
-        # If the model has no model, then the serializer will be inlined
-        if not hasattr(serializer, 'Meta') or not hasattr(serializer.Meta, 'model'):
+        component_name = self._get_serializer_component_name(serializer)
+
+        if component_name is None:
             return None
 
-        model_name = serializer.Meta.model.__name__
         content = self._map_serializer(serializer)
-
-        return {model_name: content}
+        return {component_name: content}
 
     def _get_operation_id(self, path, method):
         """
@@ -490,8 +504,8 @@ def _get_serializer(self, path, method):
             return None
 
     def _get_reference(self, serializer):
-        model_name = serializer.Meta.model.__name__
-        return {'$ref': '#/components/schemas/{}'.format(model_name)}
+        component_name = self._get_serializer_component_name(serializer)
+        return {'$ref': '#/components/schemas/{}'.format(component_name)}
 
     def _get_request_body(self, path, method):
         if method not in ('PUT', 'PATCH', 'POST'):

tests/schemas/test_openapi.py

@@ -758,4 +758,4 @@ def test_serializer_model(self):
         print(schema)
         assert 'components' in schema
         assert 'schemas' in schema['components']
-        assert 'OpenAPIExample' in schema['components']['schemas']
+        assert 'ExampleModel' in schema['components']['schemas']