Flask-Restless

Flask-Restless provides simple generation of ReSTful APIs for database models defined using SQLAlchemy (or Flask-SQLAlchemy). The generated APIs satisfy the requirements of the JSON API specification.

This is the documentation for version 1.0.0b2. See also the the most recent stable version documentation and the development version documentation

Warning

This is a “beta” version, so there may be more bugs than usual. There is one fairly serious known issue with this version. Updating relationships via association proxies is not working correctly. We cannot support many-to-many relationships until this is resolved. If you have any insight on how to fix this, please comment on GitHub issue #480.

User’s guide

How to use Flask-Restless in your own projects. Much of the documentation in this chapter assumes some familiarity with the terminology and interfaces of the JSON API specification.

API reference

A technical description of the classes, functions, and idioms of Flask-Restless.

Additional information

Meta-information on Flask-Restless.