This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Magically create swagger documentation as you magically create your RESTful API

Project Description

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.
Release History

Release History

This version
History Node

0.2.1

History Node

0.2.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
flask_restless_swagger-0.2.1-py2.py3-none-any.whl (895.4 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Mar 7, 2016
flask-restless-swagger-0.2.1.tar.gz (890.4 kB) Copy SHA256 Checksum SHA256 Source Mar 7, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting