drf-yasg
1.6.0

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 »
  • drf-yasg
  • Edit on GitHub

drf-yasg¶

Table of contents:

  • drf-yasg - Yet another Swagger generator
    • Features
    • Table of contents
    • Usage
    • Background
    • Third-party integrations
  • Serving the schema
    • get_schema_view and the SchemaView class
    • Renderers and codecs
    • Management command
  • Functional overview
    • OpenAPI specification overview
    • Default behavior
    • A note on limitations
  • Describing authentication schemes
    • Security definitions
    • Security requirements
    • swagger-ui as OAuth2 client
  • Custom schema generation
    • Excluding endpoints
    • The @swagger_auto_schema decorator
    • Serializer Meta nested class
    • Subclassing and extending
  • Customizing the web UI
  • Settings
    • SWAGGER_SETTINGS
    • REDOC_SETTINGS
  • Contributing
    • Issues
    • Pull requests
    • Maintainer’s notes
  • License
    • BSD 3-Clause License
  • Changelog
    • 1.6.0
    • 1.5.1
    • 1.5.0
    • 1.4.7
    • 1.4.6
    • 1.4.5
    • 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

Source code documentation¶

  • Index
  • Module Index
  • Search Page
  • drf_yasg package
    • drf_yasg.codecs
    • drf_yasg.errors
    • drf_yasg.generators
    • drf_yasg.inspectors
    • drf_yasg.middleware
    • drf_yasg.openapi
    • drf_yasg.renderers
    • drf_yasg.utils
    • drf_yasg.views
Next

© Copyright 2018, Cristi V.. Revision 51ec0726.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 1.6.0
Versions
latest
stable
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.