Metadata-Version: 2.1
Name: django-swagger-render
Version: 0.1.0
Summary: Swagger documentation in Django
Home-page: UNKNOWN
Author: Emir Amanbekov
Author-email: amanbekoff@gmail.com
License: MIT
Project-URL: Source, https://github.com/eamanbekov/django-swagger-render
Description: # Django Swagger Render
        
        ## Getting Started
        
        ### Prerequisites
        
        - python >= 3.5
        - Django >= 2.0
        
        ### Installation
        
        Install using pip
        
        ```
        pip install django-swagger-render
        ```
        
        Add 'swagger_render' to your INSTALLED_APPS setting.
        
        ```
        INSTALLED_APPS = [
            ...
            'swagger_render',
        ]
        ```
        
        Create the folder where you will store your documentation
        
        ```
        mkdir docs
        ```
        
        Create the `index.yml` file with some `OPENAPI` or `Swagger` specifications
        
        ```
        touch docs/index.yml
        ```
        
        Serve your documentation files
        ```
        urlpatterns += static('/docs/', document_root='docs')
        ```
        
        Add `SWAGGER_YAML_FILENAME` setting to your `settings.py`
        
        ```
        SWAGGER_YAML_FILENAME = '/docs/index.yml'
        ```
        
        Add the `SwaggerUIView` to your urls
        
        ```
        from swagger_render.views import SwaggerUIView
        
        
        urlpatterns = [
            ...
            path('swagger/', SwaggerUIView.as_view()),
        ]
        ```
        
        Voila!
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.5
Description-Content-Type: text/markdown
