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.

Source Distribution

Flask-Swag-0.1.2.tar.gz (790.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page