Skip to main content

Django swagger UI is a viewer for Swagger YAML files as html.

Project description

Django swagger UI is a viewer for Swagger YAML files as html. based on swagger-yaml-to-html.py.

Quick start

  1. Add “swagger_ui” to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        'swagger_ui',
        ...
    ]
  2. Include the swagger ui URLconf in your project urls.py like this:

    path('', include('swagger_ui.urls')),
  3. Add this variable SWAGGER_YAML_FILE to settings.py pointing to your YAML file

  4. You will find the swagger api documentation in /api-doc/.

screenshots/1.png

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-swagger-ui-0.1.11.tar.gz (380.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page