Metadata-Version: 2.1
Name: flask-swagger-init
Version: 23.51.13
Summary: A library for generating and publishing Swagger specifications for Flask applications.
Home-page: https://github.com/krlsedu/flask-swagger-generator.git
Author: Carlos Eduardo
License: MIT
Keywords: Flask,swagger,swagger generator,OpenAPI
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: Flask >=1.1.1
Requires-Dist: marshmallow >=3.0.0
Requires-Dist: setuptools ~=51.0.0

# 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).


