drf-yasg
1.10.2
Table of contents:
drf-yasg - Yet another Swagger generator
Serving the schema
Functional overview
Describing authentication schemes
Custom schema generation
Customizing the web UI
Settings
Contributing
License
Changelog
drf_yasg package
drf-yasg
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
add_manual_fields() (drf_yasg.inspectors.FieldInspector method)
add_manual_parameters() (drf_yasg.inspectors.InlineSerializerInspector method)
(drf_yasg.inspectors.SwaggerAutoSchema method)
apply_cache() (drf_yasg.views.SchemaView class method)
as_cached_view() (drf_yasg.views.SchemaView class method)
as_odict() (drf_yasg.openapi.SwaggerDict method)
authentication_classes (drf_yasg.views.SchemaView attribute)
B
BaseInspector (class in drf_yasg.inspectors)
body_methods (drf_yasg.inspectors.ViewInspector attribute)
C
CamelCaseJSONFilter (class in drf_yasg.inspectors)
ChoiceFieldInspector (class in drf_yasg.inspectors)
codec_class (drf_yasg.renderers.OpenAPIRenderer attribute)
(drf_yasg.renderers.SwaggerJSONRenderer attribute)
(drf_yasg.renderers.SwaggerYAMLRenderer attribute)
Contact (class in drf_yasg.openapi)
coreapi_field_to_parameter() (drf_yasg.inspectors.CoreAPICompatInspector method)
CoreAPICompatInspector (class in drf_yasg.inspectors)
create_view() (drf_yasg.generators.OpenAPISchemaGenerator method)
D
decimal_as_float() (in module drf_yasg.utils)
deferred_never_cache() (in module drf_yasg.views)
determine_path_prefix() (drf_yasg.generators.OpenAPISchemaGenerator method)
DictFieldInspector (class in drf_yasg.inspectors)
DjangoRestResponsePagination (class in drf_yasg.inspectors)
drf_yasg.codecs (module)
drf_yasg.errors (module)
drf_yasg.generators (module)
drf_yasg.inspectors (module)
drf_yasg.middleware (module)
drf_yasg.openapi (module)
drf_yasg.renderers (module)
drf_yasg.utils (module)
drf_yasg.views (module)
E
endpoint_enumerator_class (drf_yasg.generators.OpenAPISchemaGenerator attribute)
EndpointEnumerator (class in drf_yasg.generators)
F
field_inspectors (drf_yasg.inspectors.ViewInspector attribute)
field_to_swagger_object() (drf_yasg.inspectors.ChoiceFieldInspector method)
(drf_yasg.inspectors.DictFieldInspector method)
(drf_yasg.inspectors.FieldInspector method)
(drf_yasg.inspectors.FileFieldInspector method)
(drf_yasg.inspectors.HiddenFieldInspector method)
(drf_yasg.inspectors.InlineSerializerInspector method)
(drf_yasg.inspectors.RelatedFieldInspector method)
(drf_yasg.inspectors.SerializerMethodFieldInspector method)
(drf_yasg.inspectors.SimpleFieldInspector method)
(drf_yasg.inspectors.StringDefaultFieldInspector method)
FieldInspector (class in drf_yasg.inspectors)
FileFieldInspector (class in drf_yasg.inspectors)
filter_inspectors (drf_yasg.inspectors.ViewInspector attribute)
filter_none() (in module drf_yasg.utils)
FilterInspector (class in drf_yasg.inspectors)
force_real_str() (in module drf_yasg.utils)
force_serializer_instance() (in module drf_yasg.utils)
format (drf_yasg.renderers.OpenAPIRenderer attribute)
(drf_yasg.renderers.ReDocRenderer attribute)
(drf_yasg.renderers.SwaggerJSONRenderer attribute)
(drf_yasg.renderers.SwaggerUIRenderer attribute)
(drf_yasg.renderers.SwaggerYAMLRenderer attribute)
FORMAT_BASE64 (in module drf_yasg.openapi)
FORMAT_BINARY (in module drf_yasg.openapi)
FORMAT_DATE (in module drf_yasg.openapi)
FORMAT_DATETIME (in module drf_yasg.openapi)
FORMAT_DOUBLE (in module drf_yasg.openapi)
FORMAT_EMAIL (in module drf_yasg.openapi)
FORMAT_FLOAT (in module drf_yasg.openapi)
FORMAT_INT32 (in module drf_yasg.openapi)
FORMAT_INT64 (in module drf_yasg.openapi)
FORMAT_IPV4 (in module drf_yasg.openapi)
FORMAT_IPV6 (in module drf_yasg.openapi)
FORMAT_PASSWORD (in module drf_yasg.openapi)
FORMAT_SLUG (in module drf_yasg.openapi)
FORMAT_URI (in module drf_yasg.openapi)
FORMAT_UUID (in module drf_yasg.openapi)
G
generator_class (drf_yasg.views.SchemaView attribute)
get() (drf_yasg.openapi.ReferenceResolver method)
(drf_yasg.views.SchemaView method)
get_api_endpoints() (drf_yasg.generators.EndpointEnumerator method)
get_base_path() (drf_yasg.openapi.Swagger class method)
get_consumes() (drf_yasg.inspectors.SwaggerAutoSchema method)
(in module drf_yasg.utils)
get_default_response_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_default_responses() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_description() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_endpoints() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_field_default() (in module drf_yasg.utils)
get_filter_parameters() (drf_yasg.inspectors.CoreAPICompatInspector method)
(drf_yasg.inspectors.FilterInspector method)
(drf_yasg.inspectors.ViewInspector method)
get_operation() (drf_yasg.generators.OpenAPISchemaGenerator method)
(drf_yasg.inspectors.SwaggerAutoSchema method)
(drf_yasg.inspectors.ViewInspector method)
get_operation_id() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_operation_keys() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_overrides() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_paginated_response() (drf_yasg.inspectors.DjangoRestResponsePagination method)
(drf_yasg.inspectors.PaginatorInspector method)
(drf_yasg.inspectors.ViewInspector method)
get_pagination_parameters() (drf_yasg.inspectors.ViewInspector method)
get_paginator_parameters() (drf_yasg.inspectors.CoreAPICompatInspector method)
(drf_yasg.inspectors.PaginatorInspector method)
get_parameter_name() (drf_yasg.inspectors.InlineSerializerInspector method)
get_path_from_regex() (drf_yasg.generators.EndpointEnumerator method)
get_path_item() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_path_parameters() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_paths() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_produces() (drf_yasg.inspectors.SwaggerAutoSchema method)
(in module drf_yasg.utils)
get_property_name() (drf_yasg.inspectors.InlineSerializerInspector method)
get_query_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_query_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_redoc_settings() (drf_yasg.renderers.ReDocRenderer method)
get_request_body_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_request_body_schema() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_request_form_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_request_parameters() (drf_yasg.inspectors.InlineSerializerInspector method)
(drf_yasg.inspectors.SerializerInspector method)
get_request_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_response_schemas() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_response_serializers() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_responses() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_schema() (drf_yasg.generators.OpenAPISchemaGenerator method)
(drf_yasg.inspectors.InlineSerializerInspector method)
(drf_yasg.inspectors.SerializerInspector method)
get_schema_view() (in module drf_yasg.views)
get_security() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_serializer_class() (in module drf_yasg.utils)
get_serializer_ref_name() (drf_yasg.inspectors.InlineSerializerInspector method)
(in module drf_yasg.utils)
get_summary() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_swagger_ui_settings() (drf_yasg.renderers.SwaggerUIRenderer method)
get_tags() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_view_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
getdefault() (drf_yasg.openapi.ReferenceResolver method)
guess_response_status() (in module drf_yasg.utils)
H
has() (drf_yasg.openapi.ReferenceResolver method)
HiddenFieldInspector (class in drf_yasg.inspectors)
I
implicit_body_methods (drf_yasg.inspectors.ViewInspector attribute)
IN_BODY (in module drf_yasg.openapi)
IN_FORM (in module drf_yasg.openapi)
IN_HEADER (in module drf_yasg.openapi)
IN_PATH (in module drf_yasg.openapi)
IN_QUERY (in module drf_yasg.openapi)
Info (class in drf_yasg.openapi)
InlineSerializerInspector (class in drf_yasg.inspectors)
is_camel_case() (drf_yasg.inspectors.CamelCaseJSONFilter method)
is_deprecated() (drf_yasg.inspectors.SwaggerAutoSchema method)
is_list_view() (in module drf_yasg.utils)
Items (class in drf_yasg.openapi)
K
keys() (drf_yasg.openapi.ReferenceResolver method)
L
License (class in drf_yasg.openapi)
M
make_body_parameter() (drf_yasg.inspectors.SwaggerAutoSchema method)
make_swagger_name() (in module drf_yasg.openapi)
media_type (drf_yasg.codecs.OpenAPICodecJson attribute)
(drf_yasg.codecs.OpenAPICodecYaml attribute)
(drf_yasg.renderers.OpenAPIRenderer attribute)
(drf_yasg.renderers.SwaggerJSONRenderer attribute)
(drf_yasg.renderers.SwaggerYAMLRenderer attribute)
merge_params() (in module drf_yasg.utils)
N
no_body (class in drf_yasg.utils)
NotHandled (in module drf_yasg.inspectors)
O
OpenAPICodecJson (class in drf_yasg.codecs)
OpenAPICodecYaml (class in drf_yasg.codecs)
OpenAPIRenderer (class in drf_yasg.renderers)
OpenAPISchemaGenerator (class in drf_yasg.generators)
Operation (class in drf_yasg.openapi)
OPERATION_NAMES (drf_yasg.openapi.PathItem attribute)
operations (drf_yasg.openapi.PathItem attribute)
OR_REF (drf_yasg.openapi.Schema attribute)
P
paginator_inspectors (drf_yasg.inspectors.ViewInspector attribute)
PaginatorInspector (class in drf_yasg.inspectors)
param_list_to_odict() (in module drf_yasg.utils)
Parameter (class in drf_yasg.openapi)
PathItem (class in drf_yasg.openapi)
Paths (class in drf_yasg.openapi)
permission_classes (drf_yasg.views.SchemaView attribute)
probe_field_inspectors() (drf_yasg.inspectors.FieldInspector method)
probe_inspectors() (drf_yasg.inspectors.BaseInspector method)
process_exception() (drf_yasg.middleware.SwaggerExceptionMiddleware method)
process_result() (drf_yasg.inspectors.BaseInspector method)
(drf_yasg.inspectors.CamelCaseJSONFilter method)
public (drf_yasg.views.SchemaView attribute)
R
RecursiveFieldInspector (class in drf_yasg.inspectors)
ReDocOldRenderer (class in drf_yasg.renderers)
ReDocRenderer (class in drf_yasg.renderers)
ReferenceResolver (class in drf_yasg.openapi)
ReferencingSerializerInspector (class in drf_yasg.inspectors)
RelatedFieldInspector (class in drf_yasg.inspectors)
renderer_classes (drf_yasg.views.SchemaView attribute)
replace_version() (drf_yasg.generators.EndpointEnumerator method)
resolve_ref() (in module drf_yasg.openapi)
Response (class in drf_yasg.openapi)
Responses (class in drf_yasg.openapi)
S
Schema (class in drf_yasg.openapi)
schema (drf_yasg.views.SchemaView attribute)
SCHEMA_DEFINITIONS (in module drf_yasg.openapi)
SchemaRef (class in drf_yasg.openapi)
SchemaView (class in drf_yasg.views)
scopes (drf_yasg.openapi.ReferenceResolver attribute)
serializer_to_parameters() (drf_yasg.inspectors.ViewInspector method)
serializer_to_schema() (drf_yasg.inspectors.ViewInspector method)
SerializerInspector (class in drf_yasg.inspectors)
SerializerMethodFieldInspector (class in drf_yasg.inspectors)
set() (drf_yasg.openapi.ReferenceResolver method)
set_context() (drf_yasg.renderers.ReDocRenderer method)
(drf_yasg.renderers.SwaggerUIRenderer method)
setdefault() (drf_yasg.openapi.ReferenceResolver method)
should_filter() (drf_yasg.inspectors.ViewInspector method)
should_include_endpoint() (drf_yasg.generators.EndpointEnumerator method)
should_page() (drf_yasg.inspectors.ViewInspector method)
SimpleFieldInspector (class in drf_yasg.inspectors)
StringDefaultFieldInspector (class in drf_yasg.inspectors)
Swagger (class in drf_yasg.openapi)
swagger_auto_schema() (in module drf_yasg.utils)
swagger_serializer_method() (in module drf_yasg.utils)
SwaggerAutoSchema (class in drf_yasg.inspectors)
SwaggerDict (class in drf_yasg.openapi)
SwaggerError
SwaggerExceptionMiddleware (class in drf_yasg.middleware)
SwaggerGenerationError
SwaggerJSONRenderer (class in drf_yasg.renderers)
SwaggerUIRenderer (class in drf_yasg.renderers)
SwaggerValidationError
SwaggerYAMLRenderer (class in drf_yasg.renderers)
T
template (drf_yasg.renderers.ReDocOldRenderer attribute)
(drf_yasg.renderers.ReDocRenderer attribute)
(drf_yasg.renderers.SwaggerUIRenderer attribute)
TYPE_ARRAY (in module drf_yasg.openapi)
TYPE_BOOLEAN (in module drf_yasg.openapi)
TYPE_FILE (in module drf_yasg.openapi)
TYPE_INTEGER (in module drf_yasg.openapi)
TYPE_NUMBER (in module drf_yasg.openapi)
TYPE_OBJECT (in module drf_yasg.openapi)
TYPE_STRING (in module drf_yasg.openapi)
U
unescape() (drf_yasg.generators.EndpointEnumerator method)
unescape_path() (drf_yasg.generators.EndpointEnumerator method)
unset (class in drf_yasg.utils)
url (drf_yasg.generators.OpenAPISchemaGenerator attribute)
use_definitions (drf_yasg.inspectors.InlineSerializerInspector attribute)
(drf_yasg.inspectors.ReferencingSerializerInspector attribute)
V
VALIDATORS (in module drf_yasg.codecs)
ViewInspector (class in drf_yasg.inspectors)
W
with_scope() (drf_yasg.openapi.ReferenceResolver method)
with_ui() (drf_yasg.views.SchemaView class method)
without_ui() (drf_yasg.views.SchemaView class method)
Y
yaml_sane_dump() (in module drf_yasg.codecs)
yaml_sane_load() (in module drf_yasg.codecs)
Read the Docs
v: 1.10.2
Versions
latest
stable
1.10.2
1.10.1
1.10.0
1.9.2
1.9.1
1.9.0
1.8.0
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.2
1.6.1
1.6.0
1.5.1
1.5.0
1.4.7
1.4.6
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.