Welcome to Flask-RESTX’s documentation!

Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs. Flask-RESTX encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTX 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-restx requires Python 2.7+.

Installation

You can install flask-restx with pip:

$ pip install flask-restx

or with easy_install:

$ easy_install flask-restx

Documentation

This part of the documentation will show you how to get started in using Flask-RESTX with Flask.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Indices and tables