Skip to content

Commit 84e8f4d

Browse files
committed
Add DEFAULT_SCHEMA_GENERATOR_CLASS setting
1 parent d99550e commit 84e8f4d

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

rest_framework/management/commands/generate_schema.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from django.core.management.base import BaseCommand
22

3-
from rest_framework.renderers import CoreJSONRenderer
4-
from rest_framework.schemas import SchemaGenerator
5-
3+
from rest_framework.renderers import CoreJSONRenderer, JSONRenderer
4+
from rest_framework.schemas.generators import OpenAPISchemaGenerator, SchemaGenerator
5+
from rest_framework.settings import api_settings
66

77
class Command(BaseCommand):
88
help = "Generates configured API schema for project."
@@ -26,11 +26,21 @@ def add_arguments(self, parser):
2626
pass
2727

2828
def handle(self, *args, **options):
29+
generator_class = self._get_generator_class()
30+
generator = generator_class()
2931

30-
renderer = CoreJSONRenderer()
31-
generator = SchemaGenerator()
3232
schema = generator.get_schema(request=None, public=True)
3333

34+
renderer = self._get_renderer(generator)
3435
rendered_schema = renderer.render(schema, renderer_context={}).decode('utf8')
3536

3637
self.stdout.write(rendered_schema)
38+
39+
def _get_generator_class(self):
40+
return api_settings.DEFAULT_SCHEMA_GENERATOR_CLASS
41+
42+
def _get_renderer(self, generator):
43+
if isinstance(generator, OpenAPISchemaGenerator):
44+
return JSONRenderer()
45+
else:
46+
return CoreJSONRenderer()

rest_framework/settings.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757

5858
# Schema
5959
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
60+
'DEFAULT_SCHEMA_GENERATOR_CLASS': 'rest_framework.schemas.generators.SchemaGenerator',
6061

6162
# Throttling
6263
'DEFAULT_THROTTLE_RATES': {
@@ -144,6 +145,7 @@
144145
'DEFAULT_PAGINATION_CLASS',
145146
'DEFAULT_FILTER_BACKENDS',
146147
'DEFAULT_SCHEMA_CLASS',
148+
'DEFAULT_SCHEMA_GENERATOR_CLASS',
147149
'EXCEPTION_HANDLER',
148150
'TEST_REQUEST_RENDERER_CLASSES',
149151
'UNAUTHENTICATED_USER',

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy