swagger-ui-py 0.1.3

Swagger UI for Python web framework, such Tornado, Flask and Sanic.

swagger-ui-py

Swagger UI for Python web framework, such Tornado, Flask and Sanic.

Swagger UI

Swagger UI version is 3.19.3. see https://github.com/swagger-api/swagger-ui.

Usage

• Install

  pip install swagger-ui-py
  

• Code

  # for Tornado
  from swagger_ui import tornado_api_doc
  tornado_api_doc(app, config_path='./conf/test.yaml', url_prefix='/api/doc', title='API doc')
  
  # for Sanic
  from swagger_ui import sanic_api_doc
  sanic_api_doc(app, config_path='./conf/test.yaml', url_prefix='/api/doc', title='API doc')
  
  # for Flask
  from swagger_ui import flask_api_doc
  flask_api_doc(app, config_path='./conf/test.yaml', url_prefix='/api/doc', title='API doc')
  

• Edit Swagger config file (JSON or YAML)

  Please see https://swagger.io/resources/open-api/.

• Access

  http://<host>:<port>/api/doc, open the url in your browser.