Metadata-Version: 2.0
Name: flask-restless-swagger
Version: 0.2.0
Summary: Magically create swagger documentation as you magically create your RESTful API
Home-page: https://github.com/mmessmore/flask-restless-swagger
Author: Michael Messmore
Author-email: mike@messmore.org
License: BSD
Keywords: flask-restless-swagger
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Flask (>=0.10.0)
Requires-Dist: Flask-Restless (>=0.17.0)

=============================
flask-restless-swagger
=============================

.. image:: https://travis-ci.org/mmessmore/flask-restless-swagger.png?branch=master
    :target: https://travis-ci.org/mmessmore/flask-restless-swagger

.. image:: https://pypip.in/d/flask-restless-swagger/badge.png
    :target: https://pypi.python.org/pypi/flask-restless-swagger


Magically create Swagger_ documentation as you magically create your RESTful API with Flask-Restless_


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

.. _Flask-Restless: https://flask-restless.readthedocs.org/en/latest/
.. _Swagger: http://swagger.io




Documentation
-------------

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



History
-------

0.1.0 (2015-07-15)
++++++++++++++++++

* First release on PyPI.


