Skip to main content

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

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 file for details

Based on

This application is based on the flask-swagger-generator project by Coding Kitties.

Metadata

Release files for flask-swagger-init 24.14.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flask-swagger-init 24.14.1
File Size Uploaded
flask-swagger-init-24.14.1.tar.gz 16.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flask-swagger-init 24.14.1
File Interpreter ABI Platform
flask_swagger_init-24.14.1-py3-none-any.whl Python 3 none any Details

Total release size: 44.8 kB

Release files / flask-swagger-init-24.14.1.tar.gz

Download URL flask-swagger-init-24.14.1.tar.gz
Size 16.2 kB
Tags Source
SHA-256 checksum
How to use checksums
0a412c07dc138f06880003580f61a8000fa44f65da3530c254073eff281c8042
BLAKE2b-256 checksum
How to use checksums
76a8507f5cd89ca99376c24416f38bc58007e7d74b78d03b56425ff488e69fa3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.19

Release files / flask_swagger_init-24.14.1-py3-none-any.whl

Download URL flask_swagger_init-24.14.1-py3-none-any.whl
Size 28.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c6888a1204b71e254bced1640e1c681992c2502ebfb566a4e8337095fbfaae22
BLAKE2b-256 checksum
How to use checksums
c6a45f5f4dd10bd4f0c3229032f48fb2e8c63549722296e9eba4b2ed9c82637f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.19

Release history Release notifications | RSS feed

This release

24.14.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page