https://github.com/assem-ch/django-swagger-ui

Django swagger UI is a viewer for Swagger YAML files as html.
https://github.com/assem-ch/django-swagger-ui

api-documentation-tool django swagger swagger-ui

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/assem-ch/django-swagger-ui
• Owner: assem-ch
• License: bsd-3-clause
• Created: 2018-10-12T04:26:34.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-14T18:21:43.000Z (about 3 years ago)
• Last Synced: 2024-10-17T10:11:54.575Z (2 months ago)
• Topics: api-documentation-tool, django, swagger, swagger-ui
• Language: HTML
• Homepage:
• Size: 169 KB
• Stars: 26
• Watchers: 4
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=================

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/`.

.. image:: screenshots/1.png