drf_yasg package


class drf_yasg.app_settings.AppSettings(user_settings, defaults, import_strings=None)

Bases: object

Stolen from Django Rest Framework, removed caching for easier testing



class drf_yasg.codecs.OpenAPICodecJson(validators)

Bases: drf_yasg.codecs._OpenAPICodec


Dump spec into JSON.

media_type = 'application/json'
class drf_yasg.codecs.OpenAPICodecYaml(validators)

Bases: drf_yasg.codecs._OpenAPICodec


Dump spec into YAML.

media_type = 'application/yaml'
class drf_yasg.codecs._OpenAPICodec(validators)

Bases: object


Dump the given dictionary into its string representation.

Parameters:spec (dict) – a python dict
Returns:string representation of spec
Return type:str

Transform an Swagger object to a sequence of bytes.

Also performs validation and applies settings.

Parameters:document (openapi.Swagger) – Swagger spec object as generated by OpenAPISchemaGenerator
Returns:binary encoding of document
Return type:bytes

Dump an error message into an encoding-appropriate sequence of bytes


Generates the root Swagger object.

Parameters:swagger (openapi.Swagger) – Swagger spec object as generated by OpenAPISchemaGenerator
Returns:swagger spec as dict
Return type:OrderedDict
media_type = None

List of validator names to apply

drf_yasg.codecs._validate_flex(spec, codec)
drf_yasg.codecs._validate_swagger_spec_validator(spec, codec)
drf_yasg.codecs.yaml_sane_dump(data, binary)

Dump the given data dictionary into a sane format:

  • OrderedDicts are dumped as regular mappings instead of non-standard !!odict
  • multi-line mapping style instead of json-like inline style
  • list elements are indented into their parents
  • data (dict) – the data to be serializers
  • binary (bool) – True to return a utf-8 encoded binary object, False to return a string

the serialized YAML

Return type:



exception drf_yasg.errors.SwaggerError

Bases: Exception

exception drf_yasg.errors.SwaggerGenerationError

Bases: drf_yasg.errors.SwaggerError

exception drf_yasg.errors.SwaggerValidationError(msg, validator_name, spec, source_codec, *args)

Bases: drf_yasg.errors.SwaggerError


class drf_yasg.generators.OpenAPISchemaGenerator(info, version, url=None, patterns=None, urlconf=None)

Bases: object

This class iterates over all registered API endpoints and returns an appropriate OpenAPI 2.0 compliant schema. Method implementations shamelessly stolen and adapted from rest_framework SchemaGenerator.

  • info (Info) – information about the API
  • version (str) – API version string, takes preedence over the version in info
  • url (str) – API
  • patterns – if given, only these patterns will be enumerated for inclusion in the API spec
  • urlconf – if patterns is not given, use this urlconf to enumerate patterns; if not given, the default urlconf is used
create_view(callback, method, request=None)

Create a view instance from a view callback as registered in urlpatterns.

  • callback (callable) – view callback registered in urlpatterns
  • method (str) – HTTP method
  • request (rest_framework.request.Request) – request to bind to the view

the view instance


Iterate over all the registered endpoints in the API.

Parameters:request (rest_framework.request.Request) – used for returning only endpoints available to the given request
Returns:{path: (view_class, list[(http_method, view_instance)])
Return type:dict
get_operation_keys(subpath, method, view)

Return a list of keys that should be used to group an operation within the specification.

/users/                   ("users", "list"), ("users", "create")
/users/{pk}/              ("users", "read"), ("users", "update"), ("users", "delete")
/users/enabled/           ("users", "enabled")  # custom viewset list action
/users/{pk}/star/         ("users", "star")     # custom viewset detail action
/users/{pk}/groups/       ("users", "groups", "list"), ("users", "groups", "create")
/users/{pk}/groups/{pk}/  ("users", "groups", "read"), ("users", "groups", "update")
  • subpath (str) – path to the operation with any common prefix/base path removed
  • method (str) – HTTP method
  • view – the view associated with the operation
Return type:


get_overrides(view, method)

Get overrides specified for a given operation.

  • view – the view associated with the operation
  • method (str) – HTTP method

a dictionary containing any overrides set by @swagger_auto_schema

Return type:


get_path_parameters(path, view_cls)

Return a list of Parameter instances corresponding to any templated path variables.

  • path (str) – templated request path
  • view_cls (type) – the view class associated with the path

path parameters

Return type:


get_paths(endpoints, components)

Generate the Swagger Paths for the API from the given endpoints.

  • endpoints (dict) – endpoints as returned by get_endpoints
  • components (ReferenceResolver) – resolver/container for Swagger References
Return type:


get_schema(request=None, public=False)

Generate an Swagger representing the API schema.

  • request (rest_framework.request.Request) – the request used for filtering accesible endpoints and finding the spec URI
  • public (bool) – if True, all endpoints are included regardless of access through request

the generated Swagger specification

Return type:



class drf_yasg.inspectors.SwaggerAutoSchema(view, path, method, overrides, components)

Bases: object

Inspector class responsible for providing Operation definitions given a

  • view – the view associated with this endpoint
  • path (str) – the path component of the operation URL
  • method (str) – the http method of the operation
  • overrides (dict) – manual overrides as passed to @swagger_auto_schema
  • components (openapi.ReferenceResolver) – referenceable components

Add/replace parameters from the given list of automatically generated request parameters.

Parameters:parameters (list[openapi.Parameter]) – genereated parameters
Returns:modified parameters
Return type:list[openapi.Parameter]

Convert an instance of coreapi.Field to a swagger Parameter object.

Parameters:field (coreapi.Field) –
Return type:openapi.Parameter
field_to_parameter(field, name, in_)

Convert a DRF serializer Field to a swagger Parameter object.

  • field (coreapi.Field) –
  • name (str) – the name of the parameter
  • in (str) – the location of the parameter, one of the openapi.IN_* constants
Return type:



Return the MIME types this endpoint can consume.

Return type:list[str]

Get the default responses determined for this view from the request serializer and request method.

Type:dict[str, openapi.Schema]

Return an operation description determined as appropriate from the view’s method and class docstrings.

Returns:the operation description
Return type:str

Get the filter parameters for a single filter backend instance.

Parameters:filter_backend (BaseFilterBackend) – the filter backend
Return type:list[openapi.Parameter]

Return the parameters added to the view by its filter backends.

Return type:list[openapi.Parameter]

Get an Operation for the given API endpoint (path, method). This includes query, body parameters and response schemas.

Parameters:operation_keys (tuple[str]) – an array of keys describing the hierarchical layout of this view in the API; e.g. ('snippets', 'list'), ('snippets', 'retrieve'), etc.
Return type:openapi.Operation

Add appropriate paging fields to a response Schema.

Parameters:response_schema (openapi.Schema) – the response schema that must be paged.
Return type:openapi.Schema

Return the parameters added to the view by its paginator.

Return type:list[openapi.Parameter]

Get the pagination parameters for a single paginator instance.

Parameters:paginator (BasePagination) – the paginator
Return type:list[openapi.Parameter]

Return the query parameters accepted by this view.

Return type:list[openapi.Parameter]

Return the request body parameters for this view.
This is either:

  • a list with a single object Parameter with a Schema derived from the request serializer
  • a list of primitive Parameters parsed as form data
Parameters:consumes (list[str]) – a list of accepted MIME types as returned by get_consumes()
Returns:a (potentially empty) list of Parameters either in: body or in: formData
Return type:list[openapi.Parameter]

Return the Schema for a given request’s body data. Only applies to PUT, PATCH and POST requests.

Parameters:serializer – the view’s request serializer as returned by get_request_serializer()
Return type:openapi.Schema

Given a Serializer, return a list of in: formData Parameters.

Parameters:serializer – the view’s request serializer as returned by get_request_serializer()
Return type:list[openapi.Parameter]

Return the request serializer (used for parsing the request payload) for this endpoint.

Returns:the request serializer, or one of Schema, SchemaRef, None

Return the openapi.Response objects calculated for this view.

Parameters:response_serializers (dict) – response serializers as returned by get_response_serializers()
Returns:a dictionary of status code to Response object
Return type:dict[str, openapi.Response]

Return the response codes that this view is expected to return, and the serializer for each response body. The return value should be a dict where the keys are possible status codes, and values are either strings, Serializers, Schema, SchemaRef or Response objects. See @swagger_auto_schema for more details.

Returns:the response serializers
Return type:dict

Get the possible responses for this view as a swagger Responses object.

Returns:the documented responses
Return type:openapi.Responses

Given a Schema object, create an in: body Parameter.

Parameters:schema (openapi.Schema) – the request body schema
Return type:openapi.Parameter

Convert a DRF Serializer instance to an openapi.Schema.

Parameters:serializer (serializers.BaseSerializer) –
Return type:openapi.Schema

Determine whether filter backend parameters should be included for this request.

Return type:bool

Determine whether paging parameters and structure should be added to this operation’s request and response.

Return type:bool

Force serializer into a Serializer instance. If it is not a Serializer class or instance, raises an assertion error.

Parameters:serializer – serializer class or instance
Returns:serializer instance


class drf_yasg.middleware.SwaggerExceptionMiddleware(get_response)

Bases: object

process_exception(request, exception)


class drf_yasg.openapi.Contact(name=None, url=None, email=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Swagger Contact object

At least one of the following fields is required:

  • name (str) – contact name
  • url (str) – contact url
  • email (str) – contact e-mail
class drf_yasg.openapi.Info(title, default_version, description=None, terms_of_service=None, contact=None, license=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Swagger Info object

  • title (str) – Required. API title.
  • default_version (str) – Required. API version string (not to be confused with Swagger spec version)
  • description (str) – API description; markdown supported
  • terms_of_service (str) – API terms of service; should be a URL
  • contact (Contact) – contact object
  • license (License) – license object
class drf_yasg.openapi.Items(type=None, format=None, enum=None, pattern=None, items=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Used when defining an array Parameter to describe the array elements.

  • type (str) – type of the array elements; must not be object
  • format (str) – value format, see OpenAPI spec
  • enum (list) – restrict possible values
  • pattern (str) – pattern if type is string
  • items (Items) – only valid if type is array
class drf_yasg.openapi.License(name, url=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Swagger License object

  • name (str) – Required. License name
  • url (str) – link to detailed license information
class drf_yasg.openapi.Operation(operation_id, responses, parameters=None, consumes=None, produces=None, description=None, tags=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Information about an API operation (path + http method combination)

  • operation_id (str) – operation ID, should be unique across all operations
  • responses (Responses) – responses returned
  • parameters (list[Parameter]) – parameters accepted
  • consumes (list[str]) – content types accepted
  • produces (list[str]) – content types produced
  • description (str) – operation description
  • tags (list[str]) – operation tags
class drf_yasg.openapi.Parameter(name, in_, description=None, required=None, schema=None, type=None, format=None, enum=None, pattern=None, items=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Describe parameters accepted by an Operation. Each parameter should be a unique combination of (name, in_). body and form parameters in the same operation are mutually exclusive.

  • name (str) – parameter name
  • in (str) – parameter location
  • description (str) – parameter description
  • required (bool) – whether the parameter is required for the operation
  • schema (Schema,SchemaRef) – required if in_ is body
  • type (str) – parameter type; required if in_ is not body; must not be object
  • format (str) – value format, see OpenAPI spec
  • enum (list) – restrict possible values
  • pattern (str) – pattern if type is string
  • items (Items) – only valid if type is array
class drf_yasg.openapi.PathItem(get=None, put=None, post=None, delete=None, options=None, head=None, patch=None, parameters=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Information about a single path

  • get (Operation) – operation for GET
  • put (Operation) – operation for PUT
  • post (Operation) – operation for POST
  • delete (Operation) – operation for DELETE
  • options (Operation) – operation for OPTIONS
  • head (Operation) – operation for HEAD
  • patch (Operation) – operation for PATCH
  • parameters (list[Parameter]) – parameters that apply to all operations
class drf_yasg.openapi.Paths(paths, **extra)

Bases: drf_yasg.openapi.SwaggerDict

A listing of all the paths in the API.

Parameters:paths (dict[str,PathItem]) –
class drf_yasg.openapi.ReferenceResolver(*scopes)

Bases: object

A mapping type intended for storing objects pointed at by Swagger Refs. Provides support and checks for different refernce scopes, e.g. ‘definitions’.

For example:

> components = ReferenceResolver('definitions', 'parameters')
> definitions = ReferenceResolver.with_scope('definitions')
> definitions.set('Article', Schema(...))
> print(components)
{'definitions': OrderedDict([('Article', Schema(...)]), 'parameters': OrderedDict()}
Parameters:scopes (str) – an enumeration of the valid scopes this resolver will contain
get(name, scope=None)

Get an object from the given scope, raise an error if it does not exist.

  • name (str) – reference name
  • scope (str) – reference scope

the object

getdefault(name, default=None, scope=None)

Get an object from the given scope or a default value if it does not exist.

  • name (str) – reference name
  • default – the default value
  • scope (str) – reference scope

the object or default

has(name, scope=None)

Check if an object exists in the given scope.

  • name (str) – reference name
  • scope (str) – reference scope

True if the object exists

Return type:


set(name, obj, scope=None)

Set an object in the given scope, raise an error if it already exists.

  • name (str) – reference name
  • obj – referenced object
  • scope (str) – reference scope
setdefault(name, maker, scope=None)

Set an object in the given scope only if it does not exist.

  • name (str) – reference name
  • maker (callable) – object factory, called only if necessary
  • scope (str) – reference scope

Return a new ReferenceResolver whose scope is defaulted and forced to scope.

Parameters:scope (str) – target scope, must be in this resolver’s scopes
Returns:the bound resolver
Return type:ReferenceResolver
class drf_yasg.openapi.Response(description, schema=None, examples=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Describes the structure of an operation’s response.

  • description (str) – response description
  • schema (Schema,SchemaRef) – sturcture of the response body
  • examples (dict) – example bodies mapped by mime type
class drf_yasg.openapi.Responses(responses, default=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Describes the expected responses of an Operation.

  • responses (dict[(str,int),Response]) – mapping of status code to response definition
  • default (Response) – description of the response structure to expect if another status code is returned
class drf_yasg.openapi.Schema(description=None, required=None, type=None, properties=None, additional_properties=None, format=None, enum=None, pattern=None, items=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Describes a complex object accepted as parameter or returned as a response.

  • description – schema description
  • required (list[str]) – list of requried property names
  • type (str) – value type; required
  • properties (list[Schema,SchemaRef]) – object properties; required if type is object
  • additional_properties (bool,Schema,SchemaRef) – allow wildcard properties not listed in properties
  • format (str) – value format, see OpenAPI spec
  • enum (list) – restrict possible values
  • pattern (str) – pattern if type is string
  • items (Schema,SchemaRef) – only valid if type is array
OR_REF = (<class 'drf_yasg.openapi.Schema'>, <class 'drf_yasg.openapi.SchemaRef'>)
class drf_yasg.openapi.SchemaRef(resolver, schema_name)

Bases: drf_yasg.openapi._Ref

Adds a reference to a named Schema defined in the #/definitions/ object.

  • resolver (ReferenceResolver) – component resolver which must contain the definition
  • schema_name (str) – schema name
class drf_yasg.openapi.Swagger(info=None, _url=None, _version=None, paths=None, definitions=None, **extra)

Bases: drf_yasg.openapi.SwaggerDict

Root Swagger object.

  • info (Info) – info object
  • _url (str) – URL used for guessing the API host, scheme and basepath
  • _version (str) – version string to override Info
  • paths (Paths) – paths object
  • definitions (dict[str,Schema]) – named models
class drf_yasg.openapi.SwaggerDict(**attrs)

Bases: collections.OrderedDict

A particular type of OrderedDict, which maps all attribute accesses to dict lookups using make_swagger_name(). Attribute names starting with _ are set on the object as-is and are not included in the specification output.

Used as a base class for all Swagger helper models.

static _as_odict(obj)

From an ordering perspective, it is desired that extra attributes such as vendor extensions stay at the bottom of the object. However, python2.7’s OrderdDict craps out if you try to insert into it before calling init. This means that subclasses must call super().__init__ as the first statement of their own __init__, which would result in the extra attributes being added first. For this reason, we defer the insertion of the attributes and require that subclasses call ._insert_extras__ at the end of their __init__ method.

class drf_yasg.openapi._Ref(resolver, name, scope, expected_type)

Bases: drf_yasg.openapi.SwaggerDict

Base class for all reference types. A reference object has only one property, $ref, which must be a JSON reference to a valid object in the specification, e.g. #/definitions/Article to refer to an article model.

  • resolver (ReferenceResolver) – component resolver which must contain the referneced object
  • name (str) – referenced object name, e.g. “Article”
  • scope (str) – reference scope, e.g. “definitions”
  • expected_type (type[SwaggerDict]) – the expected type that will be asserted on the object found in resolver

Convert a python variable name into a Swagger spec attribute name.

In particular,
  • if name starts with x_, return x-{camelCase}
  • if name is ref, return $ref
  • else return the name converted to camelCase, with trailing underscores stripped
Parameters:attribute_name (str) – python attribute name
Returns:swagger name


class drf_yasg.renderers.OpenAPIRenderer

Bases: drf_yasg.renderers._SpecRenderer

Renders the schema as a JSON document with the application/openapi+json specific mime type.


alias of OpenAPICodecJson

format = 'openapi'
media_type = 'application/openapi+json'
class drf_yasg.renderers.ReDocRenderer

Bases: drf_yasg.renderers._UIRenderer

Renders a ReDoc web interface for schema browisng. Also requires OpenAPIRenderer as an available renderer on the same view.

format = 'redoc'
template = 'drf-yasg/redoc.html'
class drf_yasg.renderers.SwaggerJSONRenderer

Bases: drf_yasg.renderers._SpecRenderer

Renders the schema as a JSON document with the generic application/json mime type.


alias of OpenAPICodecJson

format = '.json'
media_type = 'application/json'
class drf_yasg.renderers.SwaggerUIRenderer

Bases: drf_yasg.renderers._UIRenderer

Renders a swagger-ui web interface for schema browisng. Also requires OpenAPIRenderer as an available renderer on the same view.

format = 'swagger'
template = 'drf-yasg/swagger-ui.html'
class drf_yasg.renderers.SwaggerYAMLRenderer

Bases: drf_yasg.renderers._SpecRenderer

Renders the schema as a YAML document.


alias of OpenAPICodecYaml

format = '.yaml'
media_type = 'application/yaml'
class drf_yasg.renderers._SpecRenderer

Bases: rest_framework.renderers.BaseRenderer

Base class for text renderers. Handles encoding and validation.

charset = None
codec_class = None
render(data, media_type=None, renderer_context=None)
validators = ['ssv', 'flex']
classmethod with_validators(validators)
class drf_yasg.renderers._UIRenderer

Bases: rest_framework.renderers.BaseRenderer

Base class for web UI renderers. Handles loading an passing settings to the appropriate template.

charset = 'utf-8'
media_type = 'text/html'
render(swagger, accepted_media_type=None, renderer_context=None)
set_context(renderer_context, swagger)
template = ''



Given a Field, look for a RegexValidator and try to extract its pattern and return it as a string.

Parameters:regex_field (serializers.Field) – the field instance
Returns:the extracted pattern, or None
Return type:str
drf_yasg.utils.is_list_view(path, method, view)

Check if the given path/method appears to represent a list view (as opposed to a detail/instance view).

  • path (str) – view path
  • method (str) – http method
  • view (APIView) – target view
Return type:


drf_yasg.utils.serializer_field_to_swagger(field, swagger_object_type, definitions=None, **kwargs)

Convert a drf Serializer or Field instance into a Swagger object.

  • field (rest_framework.serializers.Field) – the source field
  • swagger_object_type (type[openapi.SwaggerDict]) – should be one of Schema, Parameter, Items
  • definitions (ReferenceResolver) – used to serialize Schemas by reference
  • kwargs – extra attributes for constructing the object; if swagger_object_type is Parameter, name and in_ should be provided

the swagger object

Return type:

openapi.Parameter, openapi.Items, openapi.Schema

drf_yasg.utils.swagger_auto_schema(method=None, methods=None, auto_schema=None, request_body=None, manual_parameters=None, operation_description=None, responses=None)

Decorate a view method to customize the Operation object generated from it.

method and methods are mutually exclusive and must only be present when decorating a view method that accepts more than one HTTP request method.

The auto_schema and operation_description arguments take precendence over view- or method-level values.

  • method (str) – for multi-method views, the http method the options should apply to
  • methods (list[str]) – for multi-method views, the http methods the options should apply to
  • auto_schema (SwaggerAutoSchema) – custom class to use for generating the Operation object
  • request_body (Schema,SchemaRef,Serializer) –

    custom request body, or no_body. The value given here will be used as the schema property of a Parameter with in: 'body'.

    A Schema or SchemaRef is not valid if this request consumes form-data, because form and body parameters are mutually exclusive in an Operation. If you need to set custom form parameters, you can use the manual_parameters argument.

    If a Serializer class or instance is given, it will be automatically converted into a Schema used as a body Parameter, or into a list of form Parameters, as appropriate.

  • manual_parameters (list[Parameter]) –

    a list of manual parameters to override the automatically generated ones

    Parameters are identified by their (name, in) combination, and any parameters given here will fully override automatically generated parameters if they collide.

    It is an error to supply form parameters when the request does not consume form-data.

  • operation_description (str) – operation description override
  • responses (dict[str,(Schema,SchemaRef,Response,str,Serializer)]) –

    a dict of documented manual responses keyed on response status code. If no success (2xx) response is given, one will automatically be generated from the request body and http method. If any 2xx response is given the automatic response is suppressed.

    • if a plain string is given as value, a Response with no body and that string as its description will be generated
    • if a Schema, SchemaRef is given, a Response with the schema as its body and an empty description will be generated
    • a Serializer class or instance will be converted into a Schema and treated as above
    • a Response object will be used as-is; however if its schema attribute is a Serializer, it will automatically be converted into a Schema


class drf_yasg.views.SchemaView(**kwargs)

Bases: rest_framework.views.APIView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

_ignore_model_permissions = True
classmethod as_cached_view(cache_timeout=0, cache_kwargs=None, **initkwargs)

Calls .as_view() and wraps the result in a cache_page decorator. See https://docs.djangoproject.com/en/1.11/topics/cache/

  • cache_timeout (int) – same as cache_page; set to 0 for no cache
  • cache_kwargs (dict) – dictionary of kwargs to be passed to cache_page
  • initkwargs – kwargs for .as_view()

a view instance

authentication_classes = [<class 'rest_framework.authentication.SessionAuthentication'>, <class 'rest_framework.authentication.BasicAuthentication'>]

alias of OpenAPISchemaGenerator

get(request, version='', format=None)
permission_classes = [<class 'rest_framework.permissions.AllowAny'>]
public = False
renderer_classes = (<class 'drf_yasg.renderers.SwaggerYAMLRenderer'>, <class 'drf_yasg.renderers.SwaggerJSONRenderer'>, <class 'drf_yasg.renderers.OpenAPIRenderer'>)
schema = None
classmethod with_ui(renderer='swagger', cache_timeout=0, cache_kwargs=None)

Instantiate this view with a Web UI renderer, optionally wrapped with cache_page. See https://docs.djangoproject.com/en/1.11/topics/cache/.

  • renderer (str) – UI renderer; allowed values are swagger, redoc
  • cache_timeout (int) – same as cache_page; set to 0 for no cache
  • cache_kwargs (dict) – dictionary of kwargs to be passed to cache_page

a view instance

classmethod without_ui(cache_timeout=0, cache_kwargs=None)

Instantiate this view with just JSON and YAML renderers, optionally wrapped with cache_page. See https://docs.djangoproject.com/en/1.11/topics/cache/.

  • cache_timeout (int) – same as cache_page; set to 0 for no cache
  • cache_kwargs (dict) – dictionary of kwargs to be passed to cache_page

a view instance


Decorator that adds headers to a response so that it will never be cached.

drf_yasg.views.get_schema_view(info, url=None, patterns=None, urlconf=None, public=False, validators=None, generator_class=<class 'drf_yasg.generators.OpenAPISchemaGenerator'>, authentication_classes=[<class 'rest_framework.authentication.SessionAuthentication'>, <class 'rest_framework.authentication.BasicAuthentication'>], permission_classes=[<class 'rest_framework.permissions.AllowAny'>])

Create a SchemaView class with default renderers and generators.

  • info (Info) – Required. Swagger API Info object
  • url (str) – API base url; if left blank will be deduced from the location the view is served at
  • patterns – passed to SchemaGenerator
  • urlconf – passed to SchemaGenerator
  • public (bool) – if False, includes only endpoints the current user has access to
  • validators (list) – a list of validator names to apply; allowed values are flex, ssv
  • generator_class (type) – schema generator class to use; should be a subclass of OpenAPISchemaGenerator
  • authentication_classes (tuple) – authentication classes for the schema view itself
  • permission_classes (tuple) – permission classes for the schema view itself

SchemaView class

Return type: