Skip to content

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

License

Notifications You must be signed in to change notification settings

assem-ch/django-swagger-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Django Swagger UI

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

Quick start

  1. Install the lib:

    pip install django-swagger-ui

  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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published