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).

Flask-RESTX is a community driven fork of Flask-RESTPlus

Why did we fork?

The community has decided to fork the project due to lack of response from the original author @noirbizarre. We have been discussing this eventuality for a long time.

Things evolved a bit since that discussion and a few of us have been granted maintainers access to the github project, but only the original author has access rights on the PyPi project. As such, we been unable to make any actual releases. To prevent this project from dying out, we have forked it to continue development and to support our users.


flask-restx requires Python 2.7+ or 3.4+.


You can install flask-restx with pip:

$ pip install flask-restx

or with easy_install:

$ easy_install flask-restx


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