.. Flask-RESTPlus documentation master file, created by sphinx-quickstart on Wed Aug 13 17:07:14 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to Flask-RESTPlus's documentation! ========================================== Flask-RESTPlus is an extension for Flask that adds support for quickly building REST APIs. Flask-RESTPlus encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTPlus should be easy to pick up. It provides a coherent collection of decorators and tools to describe your API and expose its documentation properly (using Swagger). Compatibility ============= flask-restplus requires Python 2.7+. Installation ============ You can install flask-restplus with pip: .. code-block:: console $ pip install flask-restplus or with easy_install: .. code-block:: console $ easy_install flask-restplus Documentation ============= This part of the documentation will show you how to get started in using Flask-RESTPlus with Flask. .. toctree:: :maxdepth: 2 installation quickstart marshalling parsing errors mask swagger postman scaling example API Reference ------------- If you are looking for information on a specific function, class or method, this part of the documentation is for you. .. toctree:: :maxdepth: 2 api Additional Notes ---------------- .. toctree:: :maxdepth: 2 contributing changelog Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`