drf-spectacular
stable
drf-spectacular
Settings
Workflow & schema customization
Client generation
FAQ
Extension Blueprints
From
drf-yasg
to OpenAPI 3
Contributing to drf-spectacular
Changelog
License
Package overview
drf-spectacular
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
A
ANY (drf_spectacular.types.OpenApiTypes attribute)
api_version (drf_spectacular.views.SpectacularAPIView attribute)
authentication_classes (drf_spectacular.views.SpectacularAPIView attribute)
(drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
AutoSchema (class in drf_spectacular.openapi)
B
BINARY (drf_spectacular.types.OpenApiTypes attribute)
BOOL (drf_spectacular.types.OpenApiTypes attribute)
BYTE (drf_spectacular.types.OpenApiTypes attribute)
C
COOKIE (drf_spectacular.utils.OpenApiParameter attribute)
custom_settings (drf_spectacular.views.SpectacularAPIView attribute)
D
data (drf_spectacular.utils.PolymorphicProxySerializer property)
DATE (drf_spectacular.types.OpenApiTypes attribute)
DATETIME (drf_spectacular.types.OpenApiTypes attribute)
DECIMAL (drf_spectacular.types.OpenApiTypes attribute)
DjangoFilterExtension (class in drf_spectacular.contrib.django_filters)
DOUBLE (drf_spectacular.types.OpenApiTypes attribute)
drf_spectacular.contrib.django_filters
module
drf_spectacular.extensions
module
drf_spectacular.hooks
module
drf_spectacular.openapi
module
drf_spectacular.utils
module
drf_spectacular.views
module
DURATION (drf_spectacular.types.OpenApiTypes attribute)
E
EMAIL (drf_spectacular.types.OpenApiTypes attribute)
extend_schema() (in module drf_spectacular.utils)
extend_schema_field() (in module drf_spectacular.utils)
extend_schema_serializer() (in module drf_spectacular.utils)
extend_schema_view() (in module drf_spectacular.utils)
F
FLOAT (drf_spectacular.types.OpenApiTypes attribute)
G
generator_class (drf_spectacular.views.SpectacularAPIView attribute)
get() (drf_spectacular.views.SpectacularAPIView method)
(drf_spectacular.views.SpectacularRedocView method)
(drf_spectacular.views.SpectacularSwaggerSplitView method)
(drf_spectacular.views.SpectacularSwaggerView method)
get_auth() (drf_spectacular.openapi.AutoSchema method)
get_callbacks() (drf_spectacular.openapi.AutoSchema method)
get_description() (drf_spectacular.openapi.AutoSchema method)
get_examples() (drf_spectacular.openapi.AutoSchema method)
get_extensions() (drf_spectacular.openapi.AutoSchema method)
get_external_docs() (drf_spectacular.openapi.AutoSchema method)
get_filter_backends() (drf_spectacular.openapi.AutoSchema method)
get_name() (drf_spectacular.extensions.OpenApiSerializerExtension method)
(drf_spectacular.extensions.OpenApiSerializerFieldExtension method)
get_operation() (drf_spectacular.openapi.AutoSchema method)
get_operation_id() (drf_spectacular.openapi.AutoSchema method)
get_override_parameters() (drf_spectacular.openapi.AutoSchema method)
get_paginated_name() (drf_spectacular.openapi.AutoSchema method)
get_redirect_url() (drf_spectacular.views.SpectacularSwaggerOauthRedirectView method)
get_request_serializer() (drf_spectacular.openapi.AutoSchema method)
get_response_serializers() (drf_spectacular.openapi.AutoSchema method)
get_schema_operation_parameters() (drf_spectacular.extensions.OpenApiFilterExtension method)
get_security_definition() (drf_spectacular.extensions.OpenApiAuthenticationExtension method)
get_security_requirement() (drf_spectacular.extensions.OpenApiAuthenticationExtension method)
get_summary() (drf_spectacular.openapi.AutoSchema method)
get_tags() (drf_spectacular.openapi.AutoSchema method)
H
HEADER (drf_spectacular.utils.OpenApiParameter attribute)
HOSTNAME (drf_spectacular.types.OpenApiTypes attribute)
I
IDN_EMAIL (drf_spectacular.types.OpenApiTypes attribute)
IDN_HOSTNAME (drf_spectacular.types.OpenApiTypes attribute)
inline_serializer() (in module drf_spectacular.utils)
INT (drf_spectacular.types.OpenApiTypes attribute)
INT32 (drf_spectacular.types.OpenApiTypes attribute)
INT64 (drf_spectacular.types.OpenApiTypes attribute)
IP4 (drf_spectacular.types.OpenApiTypes attribute)
IP6 (drf_spectacular.types.OpenApiTypes attribute)
IRI (drf_spectacular.types.OpenApiTypes attribute)
IRI_REF (drf_spectacular.types.OpenApiTypes attribute)
is_deprecated() (drf_spectacular.openapi.AutoSchema method)
J
JSON_PTR (drf_spectacular.types.OpenApiTypes attribute)
JSON_PTR_REL (drf_spectacular.types.OpenApiTypes attribute)
M
map_parsers() (drf_spectacular.openapi.AutoSchema method)
map_renderers() (drf_spectacular.openapi.AutoSchema method)
map_serializer() (drf_spectacular.extensions.OpenApiSerializerExtension method)
map_serializer_field() (drf_spectacular.extensions.OpenApiSerializerFieldExtension method)
method_mapping (drf_spectacular.openapi.AutoSchema attribute)
module
drf_spectacular.contrib.django_filters
drf_spectacular.extensions
drf_spectacular.hooks
drf_spectacular.openapi
drf_spectacular.utils
drf_spectacular.views
N
name (drf_spectacular.extensions.OpenApiAuthenticationExtension attribute)
NONE (drf_spectacular.types.OpenApiTypes attribute)
NUMBER (drf_spectacular.types.OpenApiTypes attribute)
O
OBJECT (drf_spectacular.types.OpenApiTypes attribute)
OpenApiAuthenticationExtension (class in drf_spectacular.extensions)
OpenApiCallback (class in drf_spectacular.utils)
OpenApiExample (class in drf_spectacular.utils)
OpenApiFilterExtension (class in drf_spectacular.extensions)
OpenApiParameter (class in drf_spectacular.utils)
OpenApiRequest (class in drf_spectacular.utils)
OpenApiResponse (class in drf_spectacular.utils)
OpenApiSchemaBase (class in drf_spectacular.utils)
OpenApiSerializerExtension (class in drf_spectacular.extensions)
OpenApiSerializerFieldExtension (class in drf_spectacular.extensions)
OpenApiTypes (class in drf_spectacular.types)
OpenApiViewExtension (class in drf_spectacular.extensions)
P
PASSWORD (drf_spectacular.types.OpenApiTypes attribute)
PATH (drf_spectacular.utils.OpenApiParameter attribute)
patterns (drf_spectacular.views.SpectacularAPIView attribute)
permission_classes (drf_spectacular.views.SpectacularAPIView attribute)
(drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
PolymorphicProxySerializer (class in drf_spectacular.utils)
postprocess_schema_enums() (in module drf_spectacular.hooks)
preprocess_exclude_path_format() (in module drf_spectacular.hooks)
Q
QUERY (drf_spectacular.utils.OpenApiParameter attribute)
R
REGEX (drf_spectacular.types.OpenApiTypes attribute)
renderer_classes (drf_spectacular.views.SpectacularAPIView attribute)
(drf_spectacular.views.SpectacularJSONAPIView attribute)
(drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
(drf_spectacular.views.SpectacularYAMLAPIView attribute)
resolve_serializer() (drf_spectacular.openapi.AutoSchema method)
S
serializers (drf_spectacular.utils.PolymorphicProxySerializer property)
serve_public (drf_spectacular.views.SpectacularAPIView attribute)
SpectacularAPIView (class in drf_spectacular.views)
SpectacularJSONAPIView (class in drf_spectacular.views)
SpectacularRedocView (class in drf_spectacular.views)
SpectacularSwaggerOauthRedirectView (class in drf_spectacular.views)
SpectacularSwaggerSplitView (class in drf_spectacular.views)
SpectacularSwaggerView (class in drf_spectacular.views)
SpectacularYAMLAPIView (class in drf_spectacular.views)
STR (drf_spectacular.types.OpenApiTypes attribute)
T
template_name (drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
template_name_js (drf_spectacular.views.SpectacularSwaggerView attribute)
TIME (drf_spectacular.types.OpenApiTypes attribute)
title (drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
to_internal_value() (drf_spectacular.utils.PolymorphicProxySerializer method)
to_representation() (drf_spectacular.utils.PolymorphicProxySerializer method)
U
URI (drf_spectacular.types.OpenApiTypes attribute)
URI_REF (drf_spectacular.types.OpenApiTypes attribute)
URI_TPL (drf_spectacular.types.OpenApiTypes attribute)
url (drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
url_name (drf_spectacular.views.SpectacularRedocView attribute)
(drf_spectacular.views.SpectacularSwaggerView attribute)
url_self (drf_spectacular.views.SpectacularSwaggerSplitView attribute)
urlconf (drf_spectacular.views.SpectacularAPIView attribute)
UUID (drf_spectacular.types.OpenApiTypes attribute)
V
view_replacement() (drf_spectacular.extensions.OpenApiViewExtension method)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds