{ "info": { "author": "Ruslan Didyk", "author_email": "rdidyk@tmgtop.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "falcon-swagger-ui\n=================\n\nSimple Falcon application for adding `Swagger UI`_ to your falcon\napplication.\n\nIncluded Swagger UI version: v3.10.0\n\nInstallation\n------------\n\n``pip install falcon-swagger-ui``\n\nUsage\n-----\n\nExample application:\n\n.. code:: python\n\n import falcon\n from falcon_swagger_ui import register_swaggerui_app\n\n app = falcon.API()\n\n SWAGGERUI_URL = '/swagger' # without trailing slash\n SCHEMA_URL = 'http://petstore.swagger.io/v2/swagger.json'\n\n ### For developer environment you can expose a static endpoint like:\n # import pathlib\n #\n # SCHEMA_URL = '/static/v1/swagger.json'\n # STATIC_PATH = pathlib.Path(__file__).parent / 'static'\n #\n # @see: http://falcon.readthedocs.io/en/stable/api/api.html#falcon.API.add_static_route\n # app.add_static_route('/static', str(STATIC_PATH))\n #\n\n page_title = 'Falcon Swagger Doc'\n favicon_url = 'https://falconframework.org/favicon-32x32.png'\n\n register_swaggerui_app(\n app, SWAGGERUI_URL, SCHEMA_URL,\n page_title=page_title,\n favicon_url=favicon_url,\n config={'supportedSubmitMethods': ['get'], }\n )\n\n\nRunning the example application:\n\n.. code:: bash\n\n pip install falcon gunicorn jinja2\n gunicorn example:app\n\n\nConfiguration\n-------------\n\nThe application supports overloading all Swagger UI configuration\noptions that can be JSON serialized. See\nhttps://github.com/swagger-api/swagger-ui#parameters for options.\n\nIn addition, some of the OAuth fields are exposed to special variables\nthat will be rendered into the relevant function.\n\nApplication defaults are listed below (should match SwaggerUI defaults).\n\n.. code:: python\n\n {\n # OAuth related\n 'app_name': 'null',\n 'client_realm': 'null',\n 'client_id': 'null',\n 'client_secret': 'null',\n\n # SwaggerUI base configuration, see https://github.com/swagger-api/swagger-ui#parameters\n 'docExpansion': \"none\",\n 'jsonEditor': False,\n 'defaultModelRendering': 'schema',\n 'showRequestHeaders': False,\n 'supportedSubmitMethods': ['get', 'post', 'put', 'delete', 'patch']\n }\n\n.. _Swagger UI: https://github.com/swagger-api/swagger-ui\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/rdidyk/falcon-swagger-ui/archive/1.1.2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/rdidyk/falcon-swagger-ui", "keywords": "falcon swagger", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "falcon-swagger-ui", "package_url": "https://pypi.org/project/falcon-swagger-ui/", "platform": "", "project_url": "https://pypi.org/project/falcon-swagger-ui/", "project_urls": { "Download": "https://github.com/rdidyk/falcon-swagger-ui/archive/1.1.2.tar.gz", "Homepage": "https://github.com/rdidyk/falcon-swagger-ui" }, "release_url": "https://pypi.org/project/falcon-swagger-ui/1.1.2/", "requires_dist": [ "falcon", "Jinja2" ], "requires_python": "", "summary": "Swagger UI Application for Falcon", "version": "1.1.2" }, "last_serial": 5155036, "releases": { "0.0.8": [ { "comment_text": "", "digests": { "md5": "7eb1004c2e41806276b613126c51cc1e", "sha256": "a201a01ad42e93e02ab63db2158bdd3cdc327c27189e984a879419ce4c869ffa" }, "downloads": -1, "filename": "falcon-swagger-ui-0.0.8.tar.gz", "has_sig": false, "md5_digest": "7eb1004c2e41806276b613126c51cc1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1023760, "upload_time": "2017-11-14T15:44:32", "url": "https://files.pythonhosted.org/packages/2b/7a/9b96e8b25800b544b19fe047eff4ac7d6f11ca28a32ac966ecaedc36e8e4/falcon-swagger-ui-0.0.8.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "caa4764af1057414bdb0c5d9791d4801", "sha256": "a34cc97478aa2d7e2eb2e82e5660f03b8d34620ac94d54ddbce1e63144c8ab83" }, "downloads": -1, "filename": "falcon-swagger-ui-1.0.0.tar.gz", "has_sig": false, "md5_digest": "caa4764af1057414bdb0c5d9791d4801", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4168382, "upload_time": "2018-02-19T14:24:20", "url": "https://files.pythonhosted.org/packages/6c/76/27ee4772a10b08962239737712d0c8a466e69e22c5ba53ae571ba598bb51/falcon-swagger-ui-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "6f4b0d9b590fe33190e18e408d08070f", "sha256": "203b4db5c8f27da32c0fa47f269489a5f6503d63f9a12e558ec5686a47aa68aa" }, "downloads": -1, "filename": "falcon_swagger_ui-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6f4b0d9b590fe33190e18e408d08070f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4207399, "upload_time": "2018-07-24T21:51:37", "url": "https://files.pythonhosted.org/packages/01/0d/f5cf319e763e1cfe1ecb258d3948483b0e79dcf1c8e4a5d8cd77ed879274/falcon_swagger_ui-1.1.0-py3-none-any.whl" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "f42533378e802f44ce072a951280d9ef", "sha256": "2a1acac53eba55fb584d8aaa4898a39c4a54ae19091a5584f230b2267b4acb82" }, "downloads": -1, "filename": "falcon_swagger_ui-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f42533378e802f44ce072a951280d9ef", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4207450, "upload_time": "2018-07-24T22:49:03", "url": "https://files.pythonhosted.org/packages/42/01/2e4f42d67149fec5a7045ad893322ba6058ca3a44800e5f300e60db5f4b7/falcon_swagger_ui-1.1.1-py3-none-any.whl" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "ed0c257117c9fc20c168a76da2bb5dcb", "sha256": "d49c8bf988ef492f0a9c72514fc4c5b92c5f36ffc6d87291c4bd36d9894c0171" }, "downloads": -1, "filename": "falcon_swagger_ui-1.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "ed0c257117c9fc20c168a76da2bb5dcb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4208287, "upload_time": "2019-04-17T12:40:06", "url": "https://files.pythonhosted.org/packages/65/e8/a9b95042fbd0be004189fbc1606d167efd31c65b22fe552f88f93f3a4a58/falcon_swagger_ui-1.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "de40cc34c0eb3188841de8d5c2845819", "sha256": "487162b6c365a96e5af2cd1c01dae52f4b2e2fe9d0afc220e904b385be5e6c23" }, "downloads": -1, "filename": "falcon-swagger-ui-1.1.2.tar.gz", "has_sig": false, "md5_digest": "de40cc34c0eb3188841de8d5c2845819", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4168817, "upload_time": "2019-04-17T12:40:13", "url": "https://files.pythonhosted.org/packages/ec/4b/a5872d7f90ce555d570addf5891a8f4e2b51fa6cba781328026c40c26477/falcon-swagger-ui-1.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ed0c257117c9fc20c168a76da2bb5dcb", "sha256": "d49c8bf988ef492f0a9c72514fc4c5b92c5f36ffc6d87291c4bd36d9894c0171" }, "downloads": -1, "filename": "falcon_swagger_ui-1.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "ed0c257117c9fc20c168a76da2bb5dcb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4208287, "upload_time": "2019-04-17T12:40:06", "url": "https://files.pythonhosted.org/packages/65/e8/a9b95042fbd0be004189fbc1606d167efd31c65b22fe552f88f93f3a4a58/falcon_swagger_ui-1.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "de40cc34c0eb3188841de8d5c2845819", "sha256": "487162b6c365a96e5af2cd1c01dae52f4b2e2fe9d0afc220e904b385be5e6c23" }, "downloads": -1, "filename": "falcon-swagger-ui-1.1.2.tar.gz", "has_sig": false, "md5_digest": "de40cc34c0eb3188841de8d5c2845819", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4168817, "upload_time": "2019-04-17T12:40:13", "url": "https://files.pythonhosted.org/packages/ec/4b/a5872d7f90ce555d570addf5891a8f4e2b51fa6cba781328026c40c26477/falcon-swagger-ui-1.1.2.tar.gz" } ] }