assem-ch/django-swagger-ui

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

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

2. Add "swagger_ui" to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'swagger_ui',
       ...
   ]

3. Include the swagger ui URLconf in your project urls.py like this:

   path('', include('swagger_ui.urls')),

4. Add this variable SWAGGER_YAML_FILE to settings.py pointing to your YAML file
5. You will find the swagger api documentation in /api-doc/.

django-swagger-ui's Issues

'staticfiles' is not a registered tag library

I am using Django version 3.0.2 and I have a error when I open url http://127.0.0.1:8000/api-doc.
'staticfiles' is not a registered tag library.

cannot import yaml_converter

python 3.9.5

[Feature] Specify Mutliple Swagger YAMLS

In the case documentaiton gets too big for one YAML file, we need to be able to split doc into multiple files

How can we achieve that?

External refs not working

Whenever I define ref like this $ref: "./test.yaml#/definitions/TestSchema" I am getting this error message:

Could not resolve reference: Tried to resolve a relative URL, without having a basePath. path: './test.yaml' basePath: 'undefined'