A library for generating and publishing Swagger specifications for Flask applications.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flask-swagger-init-23.52.3.tar.gz
(15.1 kB
view hashes)
Built Distribution
Close
Hashes for flask-swagger-init-23.52.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73f320982cbc12e0ef05cf47bf5328bb4e8b5c7f358366c7f4ec075ad2413e4a |
|
MD5 | 8da2b4e30e2bbe3c88c1cc691255bb1b |
|
BLAKE2b-256 | d459a7a34e0c06dd05b58f061bc4c92793bc9d854fe7507c29a4f2887d6e44f7 |
Close
Hashes for flask_swagger_init-23.52.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3e88c2610d320caad645963378431afe131978385f83233621b85777249a382 |
|
MD5 | 33219f81dbbd2bb8385ba14e9aa874b6 |
|
BLAKE2b-256 | 01d1241bbcfd6dd8905778e9585ed59f2d9f7fa39a1fb07b766b7e1c74b49523 |