mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-26 11:33:59 +03:00
6522d4ae20
* Add OpenAPIRenderer as a default for get_schema_view, and start adding schema docs * Add optional pyyaml * Updating schema docs
34 lines
1.1 KiB
Python
34 lines
1.1 KiB
Python
"""
|
|
views.py # Houses `SchemaView`, `APIView` subclass.
|
|
|
|
See schemas.__init__.py for package overview.
|
|
"""
|
|
from rest_framework import exceptions, renderers
|
|
from rest_framework.response import Response
|
|
from rest_framework.settings import api_settings
|
|
from rest_framework.views import APIView
|
|
|
|
|
|
class SchemaView(APIView):
|
|
_ignore_model_permissions = True
|
|
schema = None # exclude from schema
|
|
renderer_classes = None
|
|
schema_generator = None
|
|
public = False
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(SchemaView, self).__init__(*args, **kwargs)
|
|
if self.renderer_classes is None:
|
|
self.renderer_classes = [
|
|
renderers.OpenAPIRenderer,
|
|
renderers.CoreJSONRenderer
|
|
]
|
|
if renderers.BrowsableAPIRenderer in api_settings.DEFAULT_RENDERER_CLASSES:
|
|
self.renderer_classes += [renderers.BrowsableAPIRenderer]
|
|
|
|
def get(self, request, *args, **kwargs):
|
|
schema = self.schema_generator.get_schema(request, self.public)
|
|
if schema is None:
|
|
raise exceptions.PermissionDenied()
|
|
return Response(schema)
|