Skip to main content

Build swagger spec with Flask.

Project description

Swagger spec extractor for flask.

It supports only python3.4 and higher.

PyPI Version Build Status Documentation Status

How to use it

Flask-Swag is a Flask extesnsion.

You can configure by

from flask.ext.swag import Swag

swag = Swag(app)

then, Swagger-UI will be served at /swagger/ui/

Screenshot

You can add details to flask view functions.

from myapp.app import app
from myapp.exts import swag

@app.route('/some-list')
@swag.mark.query('page', int)
@swag.mark.response(200, "List of somethings.", some_list_schema)
def some_list():
    pass

Documentation

You can find out more info at http://flask-swag.readthedocs.org/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Flask-Swag-0.1.2.tar.gz (790.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page