Skip to main content

No project description provided

Project description

Codacy Badge Codacy Badge Build Status

Flaskdoc

FlaskDoc is an extension of the regular Flask API and adds support for Swagger/OpenAPI documentation.

Requirements

  • Python 2.7+, 3.5+

Installation

Project is still in active development. The goal is to be able to install it like this

$ pip install flaskdoc

Usage Examples

import swagger.models
import flaskdoc
from flaskdoc import swagger

blp = flaskdoc.Blueprint("sample", __name__)

@blp.route("/echo/<string:sample>",
    description="Simple Echo",
    methods=[
        swagger.GET(tags=["sample"])
    ]
)
def echo(sample):
    return sample

Release History

Meta

Distributed under Apache 2.0 License

Contributing

  • Fork it

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

flaskdoc-0.1.0a1.tar.gz (2.5 MB view hashes)

Uploaded Source

Built Distribution

flaskdoc-0.1.0a1-py2.py3-none-any.whl (548.6 kB view hashes)

Uploaded Python 2 Python 3

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