encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 00:49:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

OpenAPI: Allow separate serializers for request/response/components

Browse Source
This commit is contained in:
Aarni Koskela 2020-07-23 14:31:25 +03:00
parent 4b06e0a5a1
commit b420c930df
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
rest_framework/schemas/openapi.py
View File

@ -192,7 +192,7 @@ class AutoSchema(ViewInspector):
if method.lower() == 'delete': if method.lower() == 'delete':
return {} return {}
serializer = self.get_serializer(path, method) serializer = self.get_components_serializer(path, method)
if not isinstance(serializer, serializers.Serializer): if not isinstance(serializer, serializers.Serializer):
return {} return {}
@ -615,6 +615,18 @@ class AutoSchema(ViewInspector):
.format(view.__class__.__name__, method, path)) .format(view.__class__.__name__, method, path))
return None return None
def get_components_serializer(self, path, method):
# Override this function in a subclass if necessary.
return self.get_serializer(path, method)
def get_body_serializer(self, path, method):
# Override this function in a subclass if necessary.
return self.get_serializer(path, method)
def get_response_serializer(self, path, method):
# Override this function in a subclass if necessary.
return self.get_serializer(path, method)
def _get_reference(self, serializer): def _get_reference(self, serializer):
return {'$ref': '#/components/schemas/{}'.format(self.get_component_name(serializer))} return {'$ref': '#/components/schemas/{}'.format(self.get_component_name(serializer))}
@ -624,7 +636,7 @@ class AutoSchema(ViewInspector):
self.request_media_types = self.map_parsers(path, method) self.request_media_types = self.map_parsers(path, method)
serializer = self.get_serializer(path, method) serializer = self.get_body_serializer(path, method)
if not isinstance(serializer, serializers.Serializer): if not isinstance(serializer, serializers.Serializer):
item_schema = {} item_schema = {}
@ -648,7 +660,7 @@ class AutoSchema(ViewInspector):
self.response_media_types = self.map_renderers(path, method) self.response_media_types = self.map_renderers(path, method)
serializer = self.get_serializer(path, method) serializer = self.get_response_serializer(path, method)
if not isinstance(serializer, serializers.Serializer): if not isinstance(serializer, serializers.Serializer):
item_schema = {} item_schema = {}