Metadata-Version: 2.1
Name: sanic-swagger-ui
Version: 0.0.1
Summary: Swagger UI blueprint for Sanic
Home-page: https://github.com/diptangsu/sanic-swagger-ui
Author: Diptangsu Goswami
Author-email: diptangsu.97@gmail.com
License: MIT
Description: # Sanic Swagger UI
        
        Simple Flask blueprint for adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to your flask application.
        
        Inspired by [flask-swagger-ui](https://github.com/sveint/flask-swagger-ui).
        
        ## Installation
        
        You can install it using `pip`.
        
        ```shell
        pip install sanic_swagger_ui
        ```
        
        ## Usage
        
        ```python
        from sanic import Sanic
        from sanic import response
        from sanic_swagger_ui import get_swaggerui_blueprint
        
        app = Sanic(__name__)
        STATIC_URL = '/static'
        app.static(STATIC_URL, './static')  # set static dir path
        
        SWAGGER_URL = '/swagger'
        DOCS_PATH = STATIC_URL + '/swagger/index.yaml'  # serves files from the static dir
        
        swaggerui_blueprint = get_swaggerui_blueprint(
            DOCS_PATH,
            SWAGGER_URL,
            app_name='Swagger BP Test'
        )
        app.blueprint(swaggerui_blueprint)
        
        
        @app.route('/')
        async def index(req):
            return response.html((
                'Hello World from Sanic'
                '<br>'
                'Click <a href="/swagger/docs">here</a> to view swagger docs'),
                status=200
            )
        
        
        if __name__ == '__main__':
            app.run(debug=True)
        ```
        
        You can find this example in [examples](/examples) directory in this repository.
        
        Please add an issue if you want something added here or if you find a bug.
        
Keywords: sanic swagger
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
