package documentation
rest_framework.schemas schemas: __init__.py generators.py # Top-down schema generation inspectors.py # Per-endpoint view introspection utils.py # Shared helper functions views.py # Houses `SchemaView`, `APIView` subclass. We expose a minimal "public" API directly from `schemas`. This covers the basic use-cases: from rest_framework.schemas import ( AutoSchema, ManualSchema, get_schema_view, SchemaGenerator, ) Other access should target the submodules directly
Module | coreapi |
No module docstring; 0/1 constant, 2/6 functions, 3/4 classes documented |
Module | generators |
generators.py # Top-down schema generation |
Module | inspectors |
inspectors.py # Per-endpoint view introspection |
Module | openapi |
Undocumented |
Module | utils |
utils.py # Shared helper functions |
Module | views |
views.py # Houses `SchemaView`, `APIView` subclass. |
From __init__.py
:
Function | get |
Return a schema view. |
def get_schema_view(title=None, url=None, description=None, urlconf=None, renderer_classes=None, public=False, patterns=None, generator_class=None, authentication_classes=api_settings.DEFAULT_AUTHENTICATION_CLASSES, permission_classes=api_settings.DEFAULT_PERMISSION_CLASSES, version=None):
(source)
¶
Return a schema view.