Skip to main content

Magically create swagger documentation as you magically create your RESTful API

Project description

https://travis-ci.org/mmessmore/flask-restless-swagger.png?branch=master https://pypip.in/d/flask-restless-swagger/badge.png

Magically create Swagger documentation as you magically create your RESTful API with Flask-Restless

This has lingered a while without the love it needs due to other more pressing projects. Contributions are welcome and appreciated.

Features

This strives to be a drop in replacement for Flask-Restless’ APIManager. It wraps the APIManager calls to try to gather enough information to present a Swagger 2.0 file. It also deploys the static content for the Swagger-UI configured to point to said Swagger JSON file.

Status

Currently it “works-for-me”. There are a few terrible assumptions it makes. It probably needs some more features to be usable for everyone. Suggestions, and pull requests are welcome.

TODO

  • Add Docstrings in Models as descriptions

  • Cleanup Markup

  • Make it suck less

Documentation

The full documentation is at http://flask-restless-swagger.rtfd.org.

History

0.1.0 (2015-07-15)

  • First release on PyPI.

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-restless-swagger-0.2.1.tar.gz (890.4 kB view details)

Uploaded Source

Built Distribution

flask_restless_swagger-0.2.1-py2.py3-none-any.whl (895.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flask-restless-swagger-0.2.1.tar.gz.

File metadata

File hashes

Hashes for flask-restless-swagger-0.2.1.tar.gz
Algorithm Hash digest
SHA256 91a4ab36066839fa5dee2a3535e39109298d05603b0c14eb447f2cf5b1b27622
MD5 198465f54c57912f31caa34b612e9ecc
BLAKE2b-256 0a048a088344b8ea97688828712e4ca2781cf2b69ec8845b1bc0c70bf30c1443

See more details on using hashes here.

File details

Details for the file flask_restless_swagger-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flask_restless_swagger-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3dfe7f0bdf86c0f35136d6b463d0b3d939d87dc19e35b7ec94c767068267e075
MD5 fd8d4cae04ededd1f46b98689d730efc
BLAKE2b-256 287082ea6c120c35be089f31245a03f0bb8d495e13d933ede65e3494c0e747ce

See more details on using hashes here.

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