Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle media types application/yaml and application/json #42

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion drf_spectacular/renderers.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,37 @@
import yaml
from rest_framework.renderers import OpenAPIRenderer
import logging
from rest_framework.renderers import JSONOpenAPIRenderer, OpenAPIRenderer
#from drf_spectacular.plumbing import warn

from rest_framework.exceptions import ErrorDetail

logger = logging.getLogger(__name__)


class NoAliasOpenAPIRenderer(OpenAPIRenderer):
""" Remove this temp fix once DRF 3.11 is no longer supported """

def render(self, data, media_type=None, renderer_context=None):
detail = data.get('detail')
if detail and isinstance(detail, ErrorDetail):
if not media_type:
media_type = 'Unknown'
logger.error(f'media type {media_type}: Failure {detail}')
return False

# disable yaml advanced feature 'alias' for clean, portable, and readable output
class Dumper(yaml.SafeDumper):
def ignore_aliases(self, data):
return True

return yaml.dump(data, default_flow_style=False, sort_keys=False, Dumper=Dumper).encode('utf-8')


class ApplicationYamlOpenAPIRenderer(NoAliasOpenAPIRenderer):
media_type = 'application/yaml'
format = 'yaml'


class ApplicationJsonOpenAPIRenderer(JSONOpenAPIRenderer):
media_type = 'application/json'
format = 'json'
13 changes: 11 additions & 2 deletions drf_spectacular/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
from rest_framework.response import Response
from rest_framework.views import APIView

from drf_spectacular.renderers import NoAliasOpenAPIRenderer
from drf_spectacular.renderers import (
ApplicationYamlOpenAPIRenderer,
ApplicationJsonOpenAPIRenderer,
NoAliasOpenAPIRenderer,
)
from drf_spectacular.settings import spectacular_settings
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema
Expand All @@ -22,7 +26,12 @@ class SpectacularAPIView(APIView):
- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json
"""
renderer_classes = [NoAliasOpenAPIRenderer, JSONOpenAPIRenderer]
renderer_classes = [
NoAliasOpenAPIRenderer,
JSONOpenAPIRenderer,
ApplicationYamlOpenAPIRenderer,
ApplicationJsonOpenAPIRenderer,
]
permission_classes = spectacular_settings.SERVE_PERMISSIONS

generator_class = spectacular_settings.DEFAULT_GENERATOR_CLASS
Expand Down