Add Open API get_schema().

Author: carltongibson

rest_framework/schemas/generators.py

@@ -283,9 +283,7 @@ def get_schema(self, request=None, public=False):
         """
         Generate a `coreapi.Document` representing the API schema.
         """
-        if self.endpoints is None:
-            inspector = self.endpoint_inspector_cls(self.patterns, self.urlconf)
-            self.endpoints = inspector.get_api_endpoints()
+        self._initialise_endpoints()
 
         links = self.get_links(None if public else request)
         if not links:
@@ -301,6 +299,11 @@ def get_schema(self, request=None, public=False):
             url=url, content=links
         )
 
+    def _initialise_endpoints(self):
+        if self.endpoints is None:
+            inspector = self.endpoint_inspector_cls(self.patterns, self.urlconf)
+            self.endpoints = inspector.get_api_endpoints()
+
     def get_links(self, request=None):
         """
         Return a dictionary containing all the links that should be
@@ -491,3 +494,20 @@ def get_paths(self, request=None):
             result[subpath][method.lower()] = operation
 
         return result
+
+    def get_schema(self, request=None, public=False):
+        """
+        Generate a `coreapi.Document` representing the API schema.
+        """
+        self._initialise_endpoints()
+
+        paths = self.get_paths(None if public else request)
+        if not paths:
+            return None
+
+        schema = {
+            'basePath': self.url,
+            'paths': paths,
+        }
+
+        return schema

tests/schemas/test_openapi.py

@@ -47,14 +47,12 @@ def test_override_settings(self):
         assert isinstance(views.ExampleListView.schema, OpenAPIAutoSchema)
 
     def test_paths_construction(self):
+        """Construction of the `paths` key."""
         patterns = [
             url(r'^example/?$', views.ExampleListView.as_view()),
         ]
         generator = OpenAPISchemaGenerator(patterns=patterns)
-
-        # This happens in get_schema()
-        inspector = generator.endpoint_inspector_cls(generator.patterns, generator.urlconf)
-        generator.endpoints = inspector.get_api_endpoints()
+        generator._initialise_endpoints()
 
         paths = generator.get_paths()
 
@@ -63,3 +61,16 @@ def test_paths_construction(self):
         assert len(example_operations) == 2
         assert 'get' in example_operations
         assert 'post' in example_operations
+
+    def test_schema_construction(self):
+        """Construction of the top level dictionary."""
+        patterns = [
+            url(r'^example/?$', views.ExampleListView.as_view()),
+        ]
+        generator = OpenAPISchemaGenerator(patterns=patterns)
+
+        request = create_request('/')
+        schema = generator.get_schema(request=request)
+
+        assert 'basePath' in schema
+        assert 'paths' in schema