Welcome to Flask-RESTPlus’s documentation!

Flask-RestPlus provide syntaxic suger, helpers and automatically generated Swagger documentation on top of Flask-Restful.

Compatibility

flask-restplus requires Python 2.7+.

Installation

You can install flask-restplus with pip:

$ pip install flask-restplus

or with easy_install:

$ easy_install flask-restplus

Documentation

• Quick start
  • Swagger ui
• Syntaxic sugar
  • Route with decorator
  • abort shortcut
  • parser shortcut
  • marshal shortcut
  • Handle errors with @api.errorhandler() decorator
• Documenting your API with Swagger
  • Documenting with the @api.doc() decorator
  • Documenting with the @api.model() decorator
  • Documenting with the @api.marshal_with() decorator
  • Documenting with the @api.expect() decorator
  • Documenting with the @api.response() decorator
  • Documenting with the @api.route() decorator
  • Documenting the fields
  • Documenting the methods
  • Cascading
  • Hiding from documentation
• Swagger UI documentation
• Full example
• API
  • flask.ext.restplus
  • flask.ext.restplus.fields
  • flask.ext.restplus.reqparse
• Changelog
  • 0.7.0
  • 0.6.0
  • 0.5.1
  • 0.5.0
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1

Indices and tables

• Index
• Module Index
• Search Page