Metadata-Version: 1.1
Name: sanic-simple-swagger
Version: 0.0.8
Summary: Swagger UI for Python web framework Sanic.
Home-page: https://github.com/FerdinaKusumah/sanic_simple_swagger
Author: Ferdina kusumah
Author-email: ferdina.kusumah@gmail.com
License: MIT
Description: # Sanic OpenAPI
        Real project in [https://github.com/huge-success/sanic-openapi](https://github.com/huge-success/sanic-openapi/blob/master/README.md)
        
        This project just extends functional and fix some bugs
        ![Example Swagger UI](https://raw.githubusercontent.com/huge-success/sanic-openapi/master/images/code-to-ui.png "Swagger UI")
        
        #[Git Documentation](https://github.com/FerdinaKusumah/sanic_simple_swagger)
        
        ## Installation
        ```shell
        pip install sanic-simple-swagger
        ```
        
        #### Add OpenAPI and Swagger UI:
        ```python
        from sanic_simple_swagger import swagger_blueprint, openapi_blueprint
        app.blueprint(openapi_blueprint)
        app.blueprint(swagger_blueprint)
        ```
        
        You'll now have a Swagger UI at the URL `/swagger/index.html`.
        
        Your routes will be automatically categorized by their blueprints.
        
        ### Configure all the things
        
        ```python
        app.config['API_VERSION'] = '1.0.0'
        app.config['API_TITLE'] = 'Swagger Petstore'
        app.config['API_DESCRIPTION'] = 'This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.'
        app.config['API_TERMS_OF_SERVICE'] = 'http://swagger.io/terms/'
        app.config['API_CONTACT_EMAIL'] = 'http://swagger.io/terms/'
        app.config['API_LICENSE_NAME'] = 'Apache 2.0'
        app.config['API_LICENSE_URL'] = 'http://www.apache.org/licenses/LICENSE-2.0.html'
        app.config['schemes'] = ['http', 'https']
        ```
        
        ## Reference
        1. [Sanic](https://github.com/huge-success/sanic)
        2. [Sanic OpenAPI](https://github.com/huge-success/sanic-openapi)
Keywords: sanic swagger,python sanic swagger,sanic openapi,sanic simple swagger
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
