Navigation

  • index
  • routing table |
  • modules |
  • next |
  • Flask-Restless 0.17.0 documentation »

Flask-Restless¶

Flask-Restless provides simple generation of ReSTful APIs for database models defined using SQLAlchemy (or Flask-SQLAlchemy). The generated APIs send and receive messages in JSON format.

User’s guide¶

  • Downloading and installing Flask-Restless
  • Quickstart
  • Creating API endpoints
    • Initializing the Flask application after creating the API manager
  • Customizing the ReSTful interface
    • HTTP methods
    • API prefix
    • Collection name
    • Specifying one of many primary keys
    • Enable bulk patching or deleting
    • Custom serialization
    • Capturing validation errors
    • Exposing evaluation of SQL functions
    • Specifying which columns are provided in responses
    • Server-side pagination
    • Request preprocessors and postprocessors
    • Custom queries
  • Making search queries
    • Quick examples
    • Query format
    • Operators
    • Examples
  • Format of requests and responses
    • Date and time fields
    • Errors and error messages
    • Function evaluation
    • JSONP callbacks
    • Pagination

API reference¶

  • API

Additional information¶

  • Similar projects
  • Copyright and license
  • Changelog
    • Version 0.17.0
    • Version 0.16.0
    • Version 0.15.1
    • Version 0.15.0
    • Version 0.14.2
    • Version 0.14.1
    • Version 0.14.0
    • Version 0.13.1
    • Version 0.13.0
    • Version 0.12.1
    • Version 0.12.0
    • Version 0.11.0
    • Version 0.10.1
    • Version 0.10.0
    • Version 0.9.3
    • Version 0.9.2
    • Version 0.9.1
    • Version 0.9.0
    • Version 0.8.0
    • Version 0.7.0
    • Version 0.6
    • Version 0.5
    • Version 0.4
    • Version 0.3

About

Flask-Restless is a Flask extension which provides simple generation of ReSTful JSON APIs for database models defined using SQLAlchemy (or Flask-SQLAlchemy).

Useful Links

  • The Flask website
  • The SQLAlchemy website
  • The Flask-SQLAlchemy website
  • Flask-Restless @ PyPI
  • Flask-Restless @ github
  • Issue Tracker

This Page

  • Show Source

Quick search

Enter search terms or a module, class or function name.

© Copyright 2012, 2013, 2014, 2015 Jeffrey Finkelstein. Created using Sphinx.