Flask-Swag
==========


.. image:: https://badge.fury.io/py/Flask-Swag.svg
   :alt: PyPI Version
   :target: https://badge.fury.io/py/Flask-Swag

.. image:: https://travis-ci.org/Hardtack/Flask-Swag.svg?branch=master
   :alt: Build Status
   :target: https://travis-ci.org/Hardtack/Flask-Swag

.. image:: http://readthedocs.org/projects/flask-swag/badge/?version=latest
   :alt: Documentation Status
   :target: http://flask-swag.readthedocs.org/en/latest/?badge=latest


Flask-Swag provides utilities for extracting `Swagger <http://swagger.io/>`_
spec from Flask application.

With Flask-Swag, you can easily generate an API document from your flask application.

It provides:

*   Core utilities to generate & validate Swagger spec.

*   Swagger spec extractor for flask view functions.

*   Swagger UI blueprint & Flask extension.

User's Guide
------------

.. toctree::
   :maxdepth: 2

   quickstart
   configurations
   core
   extractor
   mark
   swag


API References
--------------

.. toctree::
   :maxdepth: 3

   api/modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`