Metadata-Version: 1.1
Name: flask-swagger-ui
Version: 3.6.0
Summary: Swagger UI blueprint for Flask
Home-page: https://github.com/sveint/flask-swagger-ui
Author: Svein Tore Koksrud Seljebotn
Author-email: sveint@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: # flask-swagger-ui
        
        Simple Flask blueprint for adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to your flask application.
        
        Included Swagger UI version: 3.6.0.
        
        ## Installation
        
        `pip install flask-swagger-ui`
        
        ## Usage
        
        Example application:
        
        ```python
        from flask import Flask
        from flask_swagger_ui import get_swaggerui_blueprint
        
        app = Flask(__name__)
        
        
        SWAGGER_URL = '/api/docs'  # URL for exposing Swagger UI (without trailing '/')
        API_URL = 'http://petstore.swagger.io/v2/swagger.json'  # Our API url (can of course be a local resource)
        
        # Call factory function to create our blueprint
        swaggerui_blueprint = get_swaggerui_blueprint(
            SWAGGER_URL,  # Swagger UI static files will be mapped to '{SWAGGER_URL}/dist/'
            API_URL,
            config={  # Swagger UI config overrides
                'app_name': "Test application"
            },
            # oauth_config={  # OAuth config. See https://github.com/swagger-api/swagger-ui#oauth2-configuration .
            #    'clientId': "your-client-id",
            #    'clientSecret': "your-client-secret-if-required",
            #    'realm': "your-realms",
            #    'appName': "your-app-name",
            #    'scopeSeparator': " ",
            #    'additionalQueryStringParams': {'test': "hello"}
            # }
        )
        
        # Register blueprint at URL
        # (URL must match the one given to factory function above)
        app.register_blueprint(swaggerui_blueprint, url_prefix=SWAGGER_URL)
        
        app.run()
        
        # Now point your browser to localhost:5000/api/docs/
        
        ```
        
        ## Configuration
        
        The blueprint supports overloading all Swagger UI configuration options that can be JSON serialized.
        See https://github.com/swagger-api/swagger-ui#parameters for options.
        
        Plugins and function parameters are not supported at this time.
        
        OAuth2 parameters can be found at https://github.com/swagger-api/swagger-ui#oauth2-configuration .
        
Keywords: flask swagger
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
