# Flask Swagger Generator
Flask swagger generator is a library to create Swagger Open API definitions
for Flask based applications. Swagger is an Interface Description Language for describing REST
APIs expressed using JSON and YAML.
## Installing
Install and update using pip:
```
pip install flask-swagger-init
```
## Documentation and Examples
COMING SOON
## A Simple Example
```python
from flask import Flask
from flask_swagger_generator.generators.swagger_view import SwaggerView
# Create the flask app
app = Flask(__name__)
...
# Create all the routes for the app
...
# Note: The swagger view must be created after all the routes have been created
# Create and publish the swagger view
SwaggerView.init(app=app,
application_version='1.0.0',
application_name='My API',
application_description='My API description')
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Based on
This application is based on the [flask-swagger-generator](https://github.com/coding-kitties/flask-swagger-generator) project by [Coding Kitties](https://github.com/coding-kitties).
Raw data
{
"_id": null,
"home_page": "https://github.com/krlsedu/flask-swagger-generator.git",
"name": "flask-swagger-init",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "Flask, swagger, swagger generator, OpenAPI",
"author": "Carlos Eduardo",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/76/a8/507f5cd89ca99376c24416f38bc58007e7d74b78d03b56425ff488e69fa3/flask-swagger-init-24.14.1.tar.gz",
"platform": null,
"description": "# Flask Swagger Generator\nFlask swagger generator is a library to create Swagger Open API definitions \nfor Flask based applications. Swagger is an Interface Description Language for describing REST \nAPIs expressed using JSON and YAML. \n\n## Installing \nInstall and update using pip:\n\n```\npip install flask-swagger-init\n```\n\n## Documentation and Examples\nCOMING SOON\n\n## A Simple Example\n\n```python\n\nfrom flask import Flask\nfrom flask_swagger_generator.generators.swagger_view import SwaggerView\n\n\n# Create the flask app\napp = Flask(__name__)\n...\n# Create all the routes for the app\n...\n\n# Note: The swagger view must be created after all the routes have been created\n# Create and publish the swagger view\nSwaggerView.init(app=app, \n application_version='1.0.0', \n application_name='My API', \n application_description='My API description')\n```\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Based on\nThis application is based on the [flask-swagger-generator](https://github.com/coding-kitties/flask-swagger-generator) project by [Coding Kitties](https://github.com/coding-kitties).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for generating and publishing Swagger specifications for Flask applications.",
"version": "24.14.1",
"project_urls": {
"Homepage": "https://github.com/krlsedu/flask-swagger-generator.git"
},
"split_keywords": [
"flask",
" swagger",
" swagger generator",
" openapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6a45f5f4dd10bd4f0c3229032f48fb2e8c63549722296e9eba4b2ed9c82637f",
"md5": "9959ab247c99ed740cf69cfaeb53445a",
"sha256": "c6888a1204b71e254bced1640e1c681992c2502ebfb566a4e8337095fbfaae22"
},
"downloads": -1,
"filename": "flask_swagger_init-24.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9959ab247c99ed740cf69cfaeb53445a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 28656,
"upload_time": "2024-04-04T13:21:22",
"upload_time_iso_8601": "2024-04-04T13:21:22.292989Z",
"url": "https://files.pythonhosted.org/packages/c6/a4/5f5f4dd10bd4f0c3229032f48fb2e8c63549722296e9eba4b2ed9c82637f/flask_swagger_init-24.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76a8507f5cd89ca99376c24416f38bc58007e7d74b78d03b56425ff488e69fa3",
"md5": "481d76264536e3d6c577752dd2480b0b",
"sha256": "0a412c07dc138f06880003580f61a8000fa44f65da3530c254073eff281c8042"
},
"downloads": -1,
"filename": "flask-swagger-init-24.14.1.tar.gz",
"has_sig": false,
"md5_digest": "481d76264536e3d6c577752dd2480b0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 16153,
"upload_time": "2024-04-04T13:21:23",
"upload_time_iso_8601": "2024-04-04T13:21:23.868141Z",
"url": "https://files.pythonhosted.org/packages/76/a8/507f5cd89ca99376c24416f38bc58007e7d74b78d03b56425ff488e69fa3/flask-swagger-init-24.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 13:21:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krlsedu",
"github_project": "flask-swagger-generator",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "flask-swagger-init"
}
JSON
