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 details)

Uploaded Source

File details

Details for the file django-swagger-ui-0.1.11.tar.gz.

File metadata

  • Download URL: django-swagger-ui-0.1.11.tar.gz
  • Upload date:
  • Size: 380.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for django-swagger-ui-0.1.11.tar.gz
Algorithm Hash digest
SHA256 97d2a092a76878c3ebfe92c24fa5c4eae815f2a4aa12872600a27206a98ab3a8
MD5 3f89570f662e44a415d834a88e868f69
BLAKE2b-256 5bedd0a563f71ccb9f40108b5540958d68e6601d7dc6bc64da554580ae3d1a69

See more details on using hashes here.

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