{ "info": { "author": "Atli Thorbjornsson", "author_email": "", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "flask-swagger\n=============\n\nA Swagger 2.0 spec extractor for Flask\n\nInstall:\n\n::\n\n pip install flask-swagger\n\nFlask-swagger provides a method (swagger) that inspects the Flask app\nfor endpoints that contain YAML docstrings with Swagger 2.0\n`Operation `__\nobjects.\n\n::\n\n class UserAPI(MethodView):\n\n def post(self):\n \"\"\"\n Create a new user\n ---\n tags:\n - users\n definitions:\n - schema:\n id: Group\n properties:\n name:\n type: string\n description: the group's name\n parameters:\n - in: body\n name: body\n schema:\n id: User\n required:\n - email\n - name\n properties:\n email:\n type: string\n description: email for user\n name:\n type: string\n description: name for user\n address:\n description: address for user\n schema:\n id: Address\n properties:\n street:\n type: string\n state:\n type: string\n country:\n type: string\n postalcode:\n type: string\n groups:\n type: array\n description: list of groups\n items:\n $ref: \"#/definitions/Group\"\n responses:\n 201:\n description: User created\n \"\"\"\n return {}\n\nFlask-swagger supports docstrings in methods of MethodView classes and\nregular Flask view functions.\n\nFollowing YAML conventions, flask-swagger searches for ``---``,\neverything preceding is provided as ``summary`` (first line) and\n``description`` (following lines) for the endpoint while everything\nafter is parsed as a swagger\n`Operation `__\nobject.\n\nIn order to support inline definition of\n`Schema `__\nobjects in\n`Parameter `__\nand\n`Response `__\nobjects, flask-swagger veers a little off from the standard. We require\nan ``id`` field for the inline Schema which is then used to correctly\nplace the\n`Schema `__\nobject in the\n`Definitions `__\nobject.\n\n`Schema `__\nobjects can be defined in a definitions section within the docstrings (see group object above) or within responses or parameters (see user object above). We alo support schema objects nested within the properties of other\n`Schema `__\nobjects. An example is shown above with the address property of User.\n\nTo expose your Swagger specification to the world you provide a Flask\nroute that does something along these lines\n\n::\n\n from flask import Flask, jsonify\n from flask_swagger import swagger\n\n app = Flask(__name__)\n\n @app.route(\"/spec\")\n def spec():\n return jsonify(swagger(app))\n\nNote that the Swagger specification returned by ``swagger(app)`` is as\nminimal as it can be. It's your job to override and add to the\nspecification as you see fit.\n\n::\n\n @app.route(\"/spec\")\n def spec():\n swag = swagger(app)\n swag['info']['version'] = \"1.0\"\n swag['info']['title'] = \"My API\"\n return jsonify(swag)\n\n`Swagger-UI `__\n\nSwagger-UI is the reason we embarked on this mission to begin with,\nflask-swagger does not however include Swagger-UI. Simply follow the\nawesome documentation over at https://github.com/swagger-api/swagger-ui\nand point your\n`swaggerUi.url `__\nto your new flask-swagger endpoint and enjoy.\n\nAcknowledgments\n\nFlask-swagger builds on ideas and code from\n`flask-sillywalk `__ and\n`flask-restful-swagger `__\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gangverk/flask-swagger", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "flask-swagger", "package_url": "https://pypi.org/project/flask-swagger/", "platform": "", "project_url": "https://pypi.org/project/flask-swagger/", "project_urls": { "Homepage": "https://github.com/gangverk/flask-swagger" }, "release_url": "https://pypi.org/project/flask-swagger/0.2.14/", "requires_dist": [ "Flask (>=0.10)", "PyYAML (>=5.1)" ], "requires_python": "", "summary": "Extract swagger specs from your flask project", "version": "0.2.14" }, "last_serial": 4987227, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "f8c3ec4fafc6e0d7ffb7ad3133df8ed5", "sha256": "5a51292f20a9477ab9d198f5586d3eeb8981dbe9044f69a75c9863cd53b77fe4" }, "downloads": -1, "filename": "flask-swagger-0.1.1.tar.gz", "has_sig": false, "md5_digest": "f8c3ec4fafc6e0d7ffb7ad3133df8ed5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4075, "upload_time": "2015-03-02T11:00:41", "url": "https://files.pythonhosted.org/packages/6c/54/5273c414db0b864b2ceb0aadb1ffe8ba3edd2bdd033733d939c667bb4773/flask-swagger-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "6560ebe3c2bb3ef20dd17ba90a5f80f5", "sha256": "a134e98ab5e361e166c1e7922059ce5f0c4be7d6e009675927811cc40b2a6d8a" }, "downloads": -1, "filename": "flask-swagger-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6560ebe3c2bb3ef20dd17ba90a5f80f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4787, "upload_time": "2015-03-07T20:42:39", "url": "https://files.pythonhosted.org/packages/f5/aa/8ffd50d96b3d2cbb9d41cc3607bf3b3c5c220261dda7da3a2500b59e9a11/flask-swagger-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "526517b7ddbded4e7e1240d67575c282", "sha256": "8178802b14b1ebee7707ffb949b1fd4999a238c89e6e67cbb388cbc72a008eb0" }, "downloads": -1, "filename": "flask-swagger-0.2.1.tar.gz", "has_sig": false, "md5_digest": "526517b7ddbded4e7e1240d67575c282", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4986, "upload_time": "2015-03-09T08:12:55", "url": "https://files.pythonhosted.org/packages/7a/79/80535803c9239a302c3853a1894f69f3f0efc144135b0a2f4786169bdd9c/flask-swagger-0.2.1.tar.gz" } ], "0.2.10": [ { "comment_text": "", "digests": { "md5": "6faba485da82e2b69e702a8cfe85f7a4", "sha256": "4d256d8be574e78718fdbe79e67316606adb9854fa8ac7c0364b4f35e40e0eb9" }, "downloads": -1, "filename": "flask-swagger-0.2.10.tar.gz", "has_sig": false, "md5_digest": "6faba485da82e2b69e702a8cfe85f7a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5769, "upload_time": "2015-10-08T21:55:28", "url": "https://files.pythonhosted.org/packages/10/06/cc106b72aee3255fc82611a591729fdce3eeea55f42774ed08522ec52d65/flask-swagger-0.2.10.tar.gz" } ], "0.2.11": [ { "comment_text": "", "digests": { "md5": "e9bc92bd5ecf78210d695703e429445f", "sha256": "766d87a2531e91c9888721f2631eed5ef633f75d740e657fe77e13606ef80fc1" }, "downloads": -1, "filename": "flask-swagger-0.2.11.tar.gz", "has_sig": false, "md5_digest": "e9bc92bd5ecf78210d695703e429445f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7037, "upload_time": "2015-11-28T21:24:10", "url": "https://files.pythonhosted.org/packages/6d/16/b0394c6ca561c9d75d2ddc678c8a58df5942dee7688d7bd48c5b27b98937/flask-swagger-0.2.11.tar.gz" } ], "0.2.12": [ { "comment_text": "", "digests": { "md5": "d28d069d3f8852465bbce3945ac38c3f", "sha256": "c0e55fff208193174746e49177604423e339fc8a8c945821272c0cf5db46f326" }, "downloads": -1, "filename": "flask-swagger-0.2.12.tar.gz", "has_sig": false, "md5_digest": "d28d069d3f8852465bbce3945ac38c3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7201, "upload_time": "2016-02-15T08:35:09", "url": "https://files.pythonhosted.org/packages/96/ce/62fdad737c7e753866bb729f97f24361ef18b6da7640a66780adbc332893/flask-swagger-0.2.12.tar.gz" } ], "0.2.13": [ { "comment_text": "", "digests": { "md5": "37fcb685450a72f06d8c069984633103", "sha256": "42420efbed1aad86f7ca6bb869df550e09591e1d540ebd3040c197906c0f0be6" }, "downloads": -1, "filename": "flask-swagger-0.2.13.tar.gz", "has_sig": false, "md5_digest": "37fcb685450a72f06d8c069984633103", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8007, "upload_time": "2016-10-01T22:33:43", "url": "https://files.pythonhosted.org/packages/68/97/4e31ac3dc4a44a4b7487eab8404a68c871b57a15811e189862d0bf0c5b55/flask-swagger-0.2.13.tar.gz" } ], "0.2.14": [ { "comment_text": "", "digests": { "md5": "9afde40d9d426a43402b5b4bf18c43e4", "sha256": "3caddb1311388eafc86f82f8e64ba386a5df6b84e5f16dfae19ca08173eba216" }, "downloads": -1, "filename": "flask_swagger-0.2.14-py2-none-any.whl", "has_sig": false, "md5_digest": "9afde40d9d426a43402b5b4bf18c43e4", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7268, "upload_time": "2019-03-26T11:27:48", "url": "https://files.pythonhosted.org/packages/18/78/2da3bf35a978127085ae6aff85d601b8842a4204fe88a506e23d0c79acc7/flask_swagger-0.2.14-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fac8fd796e86c41ec8dceeed326fd08d", "sha256": "b4085f5bc36df4c20b6548cd1413adc9cf35719b0f0695367cd542065145294d" }, "downloads": -1, "filename": "flask-swagger-0.2.14.tar.gz", "has_sig": false, "md5_digest": "fac8fd796e86c41ec8dceeed326fd08d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8645, "upload_time": "2019-03-26T11:27:50", "url": "https://files.pythonhosted.org/packages/b2/a9/a6c05fbc592ac482bf9557e47957c429d2be8cb8addfbc92853fb862ea8f/flask-swagger-0.2.14.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "0a79d8d3aa9cdbf381efa878e32d07d4", "sha256": "f9d3961574aea028931120c8e52affccc3cce24b772d562b8e84762aa4678ea7" }, "downloads": -1, "filename": "flask-swagger-0.2.2.tar.gz", "has_sig": false, "md5_digest": "0a79d8d3aa9cdbf381efa878e32d07d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5051, "upload_time": "2015-03-09T23:04:31", "url": "https://files.pythonhosted.org/packages/b8/76/954aa7fc708e9a85bb46685b6f71a035b6cb603af5ad7c6d43eb59f9365c/flask-swagger-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "c6577047faee7188ca72ccec0840c5c3", "sha256": "57fc122a4da9d93ea3e370a2fd17fda485d47f2047d522bd69c0370b9347da1f" }, "downloads": -1, "filename": "flask-swagger-0.2.3.tar.gz", "has_sig": false, "md5_digest": "c6577047faee7188ca72ccec0840c5c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5079, "upload_time": "2015-03-10T20:07:51", "url": "https://files.pythonhosted.org/packages/6c/23/b0f29ecf5751b1a80d9685171b854daa8c6d5be577951f60a619b48886fc/flask-swagger-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "f78f85e934f98b4d2bc329b6011eea03", "sha256": "d7e8835c6f8bafb7923459fd80a2512ab9971b5978101c4999a3588c30b926c7" }, "downloads": -1, "filename": "flask-swagger-0.2.4.tar.gz", "has_sig": false, "md5_digest": "f78f85e934f98b4d2bc329b6011eea03", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5650, "upload_time": "2015-03-16T10:46:38", "url": "https://files.pythonhosted.org/packages/73/04/72e798ff3d0095f5709e22d93454aa161ec5daf137827e87f95fe45b649a/flask-swagger-0.2.4.tar.gz" } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "60ed0e95930f3d5636c41c0726f19c29", "sha256": "07d6861d7e4520a1852de3c7bf684abaf7d90d0c1ae9705055f38af859672c18" }, "downloads": -1, "filename": "flask-swagger-0.2.5.tar.gz", "has_sig": false, "md5_digest": "60ed0e95930f3d5636c41c0726f19c29", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5682, "upload_time": "2015-04-15T23:55:07", "url": "https://files.pythonhosted.org/packages/e0/87/87a5f251d7e694b451726a1d917da7345306d9ac19838b6aeb811a38998b/flask-swagger-0.2.5.tar.gz" } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "6acd4f6f9e11a1f0fb08120587dc9b89", "sha256": "bd9cc538d0e2cd96a2735c663698c1a6d907643b5e63ca1c4b95a144f1c56a8e" }, "downloads": -1, "filename": "flask-swagger-0.2.6.tar.gz", "has_sig": false, "md5_digest": "6acd4f6f9e11a1f0fb08120587dc9b89", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5774, "upload_time": "2015-05-20T20:07:43", "url": "https://files.pythonhosted.org/packages/b7/0f/5597fa0c311aed3c0b7750b68c23c4b11dbb1d533985d4fa40fd6b342067/flask-swagger-0.2.6.tar.gz" } ], "0.2.7": [ { "comment_text": "", "digests": { "md5": "718f5120135b87afe6df959c4e8d73c3", "sha256": "f34b5ceace952b52e2303755844ffe6addb1c5bc3f21372bd105a15da499409a" }, "downloads": -1, "filename": "flask-swagger-0.2.7.tar.gz", "has_sig": false, "md5_digest": "718f5120135b87afe6df959c4e8d73c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5766, "upload_time": "2015-06-05T16:06:09", "url": "https://files.pythonhosted.org/packages/d8/ab/ecd0349354c6d564e69fd1eceb18714d7812667ee1c4a90358b12bbf856c/flask-swagger-0.2.7.tar.gz" } ], "0.2.8": [ { "comment_text": "", "digests": { "md5": "6ccb5cb7ca6f1fa5141fb70f9d3c34e7", "sha256": "988885d0ceac570b46ce425fa5b17ec12d9916df2cae44c3986a6a7d4e81c8a1" }, "downloads": -1, "filename": "flask-swagger-0.2.8.tar.gz", "has_sig": false, "md5_digest": "6ccb5cb7ca6f1fa5141fb70f9d3c34e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5769, "upload_time": "2015-06-21T20:14:58", "url": "https://files.pythonhosted.org/packages/21/48/4aab1f557ced224a36f7208ff4dd7348dfa740b5e52772d16405b78e855c/flask-swagger-0.2.8.tar.gz" } ], "0.2.9": [ { "comment_text": "", "digests": { "md5": "c514f09bc9d6409613cd3db32b3c2ec3", "sha256": "57675c047efffa23c5b40658b06cf46299c395919bf8301f8960fb20dd5c5661" }, "downloads": -1, "filename": "flask-swagger-0.2.9.tar.gz", "has_sig": false, "md5_digest": "c514f09bc9d6409613cd3db32b3c2ec3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5812, "upload_time": "2015-09-21T09:15:02", "url": "https://files.pythonhosted.org/packages/7a/5a/e8c12bc1f155744749f30207dae9740b7eaf8bcf13adc3abd57bb3597c96/flask-swagger-0.2.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9afde40d9d426a43402b5b4bf18c43e4", "sha256": "3caddb1311388eafc86f82f8e64ba386a5df6b84e5f16dfae19ca08173eba216" }, "downloads": -1, "filename": "flask_swagger-0.2.14-py2-none-any.whl", "has_sig": false, "md5_digest": "9afde40d9d426a43402b5b4bf18c43e4", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7268, "upload_time": "2019-03-26T11:27:48", "url": "https://files.pythonhosted.org/packages/18/78/2da3bf35a978127085ae6aff85d601b8842a4204fe88a506e23d0c79acc7/flask_swagger-0.2.14-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fac8fd796e86c41ec8dceeed326fd08d", "sha256": "b4085f5bc36df4c20b6548cd1413adc9cf35719b0f0695367cd542065145294d" }, "downloads": -1, "filename": "flask-swagger-0.2.14.tar.gz", "has_sig": false, "md5_digest": "fac8fd796e86c41ec8dceeed326fd08d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8645, "upload_time": "2019-03-26T11:27:50", "url": "https://files.pythonhosted.org/packages/b2/a9/a6c05fbc592ac482bf9557e47957c429d2be8cb8addfbc92853fb862ea8f/flask-swagger-0.2.14.tar.gz" } ] }