Allow SchemaView to handle both CoreAPI & OpenAPI.

Author: carltongibson

rest_framework/management/commands/generateschema.py

@@ -3,7 +3,6 @@
 from rest_framework import renderers
 from rest_framework.schemas import coreapi
 from rest_framework.schemas.openapi import SchemaGenerator
-from rest_framework.settings import api_settings
 
 OPENAPI_MODE = 'openapi'
 COREAPI_MODE = 'coreapi'
@@ -13,10 +12,7 @@ class Command(BaseCommand):
     help = "Generates configured API schema for project."
 
     def get_mode(self):
-        default_schema_class = api_settings.DEFAULT_SCHEMA_CLASS
-        if issubclass(default_schema_class, coreapi.AutoSchema):
-            return COREAPI_MODE
-        return OPENAPI_MODE
+        return COREAPI_MODE if coreapi.is_enabled() else OPENAPI_MODE
 
     def add_arguments(self, parser):
         parser.add_argument('--title', dest="title", default='', type=str)

rest_framework/schemas/__init__.py

@@ -22,24 +22,32 @@
 """
 from rest_framework.settings import api_settings
 
+from . import coreapi, openapi
 from .inspectors import DefaultSchema  # noqa
 from .coreapi import AutoSchema, ManualSchema, SchemaGenerator  # noqa
 
 
 def get_schema_view(
         title=None, url=None, description=None, urlconf=None, renderer_classes=None,
-        public=False, patterns=None, generator_class=SchemaGenerator,
+        public=False, patterns=None, generator_class=None,
         authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES,
         permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES):
     """
     Return a schema view.
     """
-    # Avoid import cycle on APIView
-    from .views import SchemaView
+    if generator_class is None:
+        if coreapi.is_enabled():
+            generator_class = coreapi.SchemaGenerator
+        else:
+            generator_class = openapi.SchemaGenerator
+
     generator = generator_class(
         title=title, url=url, description=description,
         urlconf=urlconf, patterns=patterns,
     )
+
+    # Avoid import cycle on APIView
+    from .views import SchemaView
     return SchemaView.as_view(
         renderer_classes=renderer_classes,
         schema_generator=generator,

rest_framework/schemas/coreapi.py

@@ -609,3 +609,8 @@ def get_link(self, path, method, base_url):
             fields=self._fields,
             description=self._description
         )
+
+
+def is_enabled():
+    """Is CoreAPI Mode enabled?"""
+    return issubclass(api_settings.DEFAULT_SCHEMA_CLASS, AutoSchema)

rest_framework/schemas/views.py

@@ -5,6 +5,7 @@
 """
 from rest_framework import exceptions, renderers
 from rest_framework.response import Response
+from rest_framework.schemas import coreapi
 from rest_framework.settings import api_settings
 from rest_framework.views import APIView
 
@@ -19,10 +20,16 @@ class SchemaView(APIView):
     def __init__(self, *args, **kwargs):
         super(SchemaView, self).__init__(*args, **kwargs)
         if self.renderer_classes is None:
-            self.renderer_classes = [
-                renderers.CoreAPIOpenAPIRenderer,
-                renderers.CoreJSONRenderer
-            ]
+            if coreapi.is_enabled():
+                self.renderer_classes = [
+                    renderers.CoreAPIOpenAPIRenderer,
+                    renderers.CoreJSONRenderer
+                ]
+            else:
+                self.renderer_classes = [
+                    renderers.OpenAPIRenderer,
+                    renderers.JSONOpenAPIRenderer,
+                ]
             if renderers.BrowsableAPIRenderer in api_settings.DEFAULT_RENDERER_CLASSES:
                 self.renderer_classes += [renderers.BrowsableAPIRenderer]
 

tests/schemas/test_coreapi.py

@@ -134,11 +134,12 @@ def put_documented_custom_action(self, request, *args, **kwargs):
         pass
 
 
-if coreapi:
-    schema_view = get_schema_view(title='Example API')
-else:
-    def schema_view(request):
-        pass
+with override_settings(REST_FRAMEWORK={'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema'}):
+    if coreapi:
+        schema_view = get_schema_view(title='Example API')
+    else:
+        def schema_view(request):
+            pass
 
 router = DefaultRouter()
 router.register('example', ExampleViewSet, basename='example')

tests/schemas/test_get_schema_view.py

@@ -0,0 +1,18 @@
+from django.test import TestCase, override_settings
+
+from rest_framework import renderers
+from rest_framework.schemas import coreapi, get_schema_view, openapi
+
+
+class GetSchemaViewTests(TestCase):
+    """For the get_schema_view() helper."""
+    def test_openapi(self):
+        schema_view = get_schema_view(title="With OpenAPI")
+        assert isinstance(schema_view.initkwargs['schema_generator'], openapi.SchemaGenerator)
+        assert renderers.OpenAPIRenderer in schema_view.cls().renderer_classes
+
+    def test_coreapi(self):
+        with override_settings(REST_FRAMEWORK={'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema'}):
+            schema_view = get_schema_view(title="With CoreAPI")
+            assert isinstance(schema_view.initkwargs['schema_generator'], coreapi.SchemaGenerator)
+            assert renderers.CoreAPIOpenAPIRenderer in schema_view.cls().renderer_classes