{ "info": { "author": "Maicon Domingues", "author_email": "dominguesm@outlook.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# tornado-swagger-ui\n\nSimple Tornado Handler for adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to your tornado application.\n\nIncluded Swagger UI version: 3.22.1.\n\n## Installation\n\n`pip install git+https://gitlab.com/api-projects-boilerplates/tornado-swagger-ui.git`\n\n## Usage\n\nExample application:\n\n```python\nimport tornado.ioloop\nimport tornado.web\nfrom tornado_swagger_ui import get_tornado_handler\n\nSWAGGER_URL = '/api/docs' # URL for exposing Swagger UI (without trailing '/')\n# Our API url (can of course be a local resource)\nAPI_URL = 'http://petstore.swagger.io/v2/swagger.json'\n\n# Call factory function to create our handler\nswagger_handlers = get_tornado_handler(\n base_url=SWAGGER_URL,\n api_url=API_URL,\n config={\n \"app_name\": \"Test application\"\n },\n # oauth_config={ # OAuth config. See https://github.com/swagger-api/swagger-ui#oauth2-configuration .\n # 'clientId': \"your-client-id\",\n # 'clientSecret': \"your-client-secret-if-required\",\n # 'realm': \"your-realms\",\n # 'appName': \"your-app-name\",\n # 'scopeSeparator': \" \",\n # 'additionalQueryStringParams': {'test': \"hello\"}\n # }\n)\n\n\nclass IndexHandler(tornado.web.RequestHandler):\n def get(self):\n self.finish(\"Tornado Swagger UI\")\n\nhandlers = [\n (r\"/\", IndexHandler)\n]\n\nhandlers.extend(swagger_handlers)\n\ndef make_app():\n return tornado.web.Application(handlers)\n\n\nif __name__ == \"__main__\":\n app = make_app()\n app.listen(5000)\n tornado.ioloop.IOLoop.current().start()\n\n# Now point your browser to localhost:5000/api/docs/\n\n```\n\n## Configuration\n\nThe handler supports overloading all Swagger UI configuration options that can be JSON serialized.\nSee https://github.com/swagger-api/swagger-ui#parameters for options.\n\nPlugins and function parameters are not supported at this time.\n\nOAuth2 parameters can be found at https://github.com/swagger-api/swagger-ui#oauth2-configuration .\n\n## \n\nBased on the package:\n\n* https://github.com/sveint/flask-swagger-ui\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/DominguesM/tornado-swagger-ui/archive/v0.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/DominguesM/tornado-swagger-ui", "keywords": "tornado,swagger,tornado-swagger", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "tornado-swagger-ui", "package_url": "https://pypi.org/project/tornado-swagger-ui/", "platform": "", "project_url": "https://pypi.org/project/tornado-swagger-ui/", "project_urls": { "Download": "https://github.com/DominguesM/tornado-swagger-ui/archive/v0.1.tar.gz", "Homepage": "https://github.com/DominguesM/tornado-swagger-ui" }, "release_url": "https://pypi.org/project/tornado-swagger-ui/0.1/", "requires_dist": [ "tornado" ], "requires_python": "", "summary": "Swagger UI for Tornado", "version": "0.1" }, "last_serial": 5183036, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "29e38669d7cc07de51085a897e337941", "sha256": "04520c479a6ce6859274e94a6d72d8e86b44f9c6f697798f1f6c0ce3af58b2a2" }, "downloads": -1, "filename": "tornado_swagger_ui-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "29e38669d7cc07de51085a897e337941", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 565090, "upload_time": "2019-04-24T15:52:07", "url": "https://files.pythonhosted.org/packages/24/bb/0bcc245a60788600d31f5ada67188e1ab1e7e2d21d5c2346cac796add346/tornado_swagger_ui-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9bf56e36d905e65ea095bdc61229f4b", "sha256": "3d56bce512d74ddaae42d7ede41e24c0eeb8e4d31e831d5c996e7f473592af67" }, "downloads": -1, "filename": "tornado_swagger_ui-0.1.tar.gz", "has_sig": false, "md5_digest": "b9bf56e36d905e65ea095bdc61229f4b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 560172, "upload_time": "2019-04-24T15:52:11", "url": "https://files.pythonhosted.org/packages/83/6a/9c1c33d158a1ad6d4c905e055f72e4a58599f0752e83399a23730c9b9362/tornado_swagger_ui-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "29e38669d7cc07de51085a897e337941", "sha256": "04520c479a6ce6859274e94a6d72d8e86b44f9c6f697798f1f6c0ce3af58b2a2" }, "downloads": -1, "filename": "tornado_swagger_ui-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "29e38669d7cc07de51085a897e337941", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 565090, "upload_time": "2019-04-24T15:52:07", "url": "https://files.pythonhosted.org/packages/24/bb/0bcc245a60788600d31f5ada67188e1ab1e7e2d21d5c2346cac796add346/tornado_swagger_ui-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9bf56e36d905e65ea095bdc61229f4b", "sha256": "3d56bce512d74ddaae42d7ede41e24c0eeb8e4d31e831d5c996e7f473592af67" }, "downloads": -1, "filename": "tornado_swagger_ui-0.1.tar.gz", "has_sig": false, "md5_digest": "b9bf56e36d905e65ea095bdc61229f4b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 560172, "upload_time": "2019-04-24T15:52:11", "url": "https://files.pythonhosted.org/packages/83/6a/9c1c33d158a1ad6d4c905e055f72e4a58599f0752e83399a23730c9b9362/tornado_swagger_ui-0.1.tar.gz" } ] }