drf-yasg
1.0.6
Table of contents:
drf-yasg - Yet another Swagger generator
Serving the schema
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
_
_as_odict() (drf_yasg.openapi.SwaggerDict static method)
_check_scope() (drf_yasg.openapi.ReferenceResolver method)
_dump_dict() (drf_yasg.codecs._OpenAPICodec method)
(drf_yasg.codecs.OpenAPICodecJson method)
(drf_yasg.codecs.OpenAPICodecYaml method)
_ignore_model_permissions (drf_yasg.views.SchemaView attribute)
_insert_extras__() (drf_yasg.openapi.SwaggerDict method)
_OpenAPICodec (class in drf_yasg.codecs)
_Ref (class in drf_yasg.openapi)
_SpecRenderer (class in drf_yasg.renderers)
_UIRenderer (class in drf_yasg.renderers)
_validate_flex() (in module drf_yasg.codecs)
_validate_swagger_spec_validator() (in module drf_yasg.codecs)
A
add_manual_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
AppSettings (class in drf_yasg.app_settings)
as_cached_view() (drf_yasg.views.SchemaView class method)
as_odict() (drf_yasg.openapi.SwaggerDict method)
authentication_classes (drf_yasg.views.SchemaView attribute)
B
body_methods (drf_yasg.inspectors.SwaggerAutoSchema attribute)
C
charset (drf_yasg.renderers._SpecRenderer attribute)
(drf_yasg.renderers._UIRenderer attribute)
codec_class (drf_yasg.renderers._SpecRenderer attribute)
(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.SwaggerAutoSchema method)
create_view() (drf_yasg.generators.OpenAPISchemaGenerator method)
D
deferred_never_cache() (in module drf_yasg.views)
drf_yasg.app_settings (module)
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
encode() (drf_yasg.codecs._OpenAPICodec method)
encode_error() (drf_yasg.codecs._OpenAPICodec method)
endpoint_enumerator_class (drf_yasg.generators.OpenAPISchemaGenerator attribute)
EndpointEnumerator (class in drf_yasg.generators)
F
field_to_parameter() (drf_yasg.inspectors.SwaggerAutoSchema method)
find_regex() (in module drf_yasg.utils)
force_serializer_instance() (in module drf_yasg.inspectors)
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
generate_swagger_object() (drf_yasg.codecs._OpenAPICodec method)
generator_class (drf_yasg.views.SchemaView attribute)
get() (drf_yasg.openapi.ReferenceResolver method)
(drf_yasg.views.SchemaView method)
get_auth_urls() (drf_yasg.renderers._UIRenderer method)
get_consumes() (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_filter_backend_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_filter_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_model_field() (in module drf_yasg.utils)
get_operation() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_operation_keys() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_overrides() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_paged_response_schema() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_pagination_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_paginator_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_path_from_regex() (drf_yasg.generators.EndpointEnumerator method)
get_path_parameters() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_paths() (drf_yasg.generators.OpenAPISchemaGenerator method)
get_query_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_query_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
get_redoc_settings() (drf_yasg.renderers._UIRenderer 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_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)
get_schema_view() (in module drf_yasg.views)
get_swagger_ui_settings() (drf_yasg.renderers._UIRenderer method)
get_view_serializer() (drf_yasg.inspectors.SwaggerAutoSchema method)
getdefault() (drf_yasg.openapi.ReferenceResolver method)
H
has() (drf_yasg.openapi.ReferenceResolver method)
I
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)
inspect_model_field() (in module drf_yasg.utils)
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._OpenAPICodec attribute)
(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)
(drf_yasg.renderers._UIRenderer attribute)
N
no_body (in module drf_yasg.utils)
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)
OR_REF (drf_yasg.openapi.Schema attribute)
P
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)
process_exception() (drf_yasg.middleware.SwaggerExceptionMiddleware method)
public (drf_yasg.views.SchemaView attribute)
R
redoc_settings (in module drf_yasg.app_settings)
ReDocRenderer (class in drf_yasg.renderers)
ReferenceResolver (class in drf_yasg.openapi)
render() (drf_yasg.renderers._SpecRenderer method)
(drf_yasg.renderers._UIRenderer method)
renderer_classes (drf_yasg.views.SchemaView attribute)
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_field_to_swagger() (in module drf_yasg.utils)
serializer_to_parameters() (drf_yasg.inspectors.SwaggerAutoSchema method)
serializer_to_schema() (drf_yasg.inspectors.SwaggerAutoSchema method)
set() (drf_yasg.openapi.ReferenceResolver method)
set_context() (drf_yasg.renderers._UIRenderer method)
setdefault() (drf_yasg.openapi.ReferenceResolver method)
should_filter() (drf_yasg.inspectors.SwaggerAutoSchema method)
should_page() (drf_yasg.inspectors.SwaggerAutoSchema method)
Swagger (class in drf_yasg.openapi)
swagger_auto_schema() (in module drf_yasg.utils)
swagger_settings (in module drf_yasg.app_settings)
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._UIRenderer 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)
user_settings (drf_yasg.app_settings.AppSettings attribute)
V
validators (drf_yasg.codecs._OpenAPICodec attribute)
(drf_yasg.renderers._SpecRenderer attribute)
VALIDATORS (in module drf_yasg.codecs)
W
with_scope() (drf_yasg.openapi.ReferenceResolver method)
with_ui() (drf_yasg.views.SchemaView class method)
with_validators() (drf_yasg.renderers._SpecRenderer class method)
without_ui() (drf_yasg.views.SchemaView class method)
Y
yaml_sane_dump() (in module drf_yasg.codecs)
Read the Docs
v: 1.0.6
Versions
latest
stable
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
.