Welcome to Flask-RESTPlus’s documentation!

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

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

• Installation
• Quick start
  • Initialization
  • A Minimal API
  • Resourceful Routing
  • Endpoints
  • Argument Parsing
  • Data Formatting
  • Full example
• Response marshalling
  • Basic Usage
  • Renaming Attributes
  • Default Values
  • Custom Fields & Multiple Values
  • Url & Other Concrete Fields
  • Complex Structures
  • List Field
  • Wildcard Field
  • Nested Field
  • The api.model() factory
  • Custom fields
  • Skip fields which value is None
  • Define model using JSON Schema
• Request Parsing
  • Basic Arguments
  • Required Arguments
  • Multiple Values & Lists
  • Other Destinations
  • Argument Locations
  • Multiple Locations
  • Advanced types handling
  • Parser Inheritance
  • File Upload
  • Error Handling
  • Error Messages
• Error handling
  • HTTPException handling
  • The Flask abort helper
  • The Flask-RESTPlus abort helper
  • The @api.errorhandler decorator
• Fields masks
  • Syntax
  • Usage
• Swagger documentation
  • Documenting with the @api.doc() decorator
  • Automatically documented models
  • The @api.marshal_with() decorator
  • The @api.expect() decorator
  • Documenting with the @api.response() decorator
  • The @api.route() decorator
  • Documenting the fields
  • Documenting the methods
  • Cascading
  • Marking as deprecated
  • Hiding from documentation
  • Documenting authorizations
  • Expose vendor Extensions
  • Export Swagger specifications
  • Swagger UI
• Postman
• Scaling your project
  • Multiple namespaces
  • Use With Blueprints
  • Multiple APIs with reusable namespaces
• Full example

API Reference

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

• API
  • Core
  • Models
  • Serialization
  • Request parsing
  • Errors
  • Schemas
  • Internals

Additional Notes

• Contributing
  • Submitting issues
  • Submitting patches (bugfix, features, …)
  • Running a local Swagger Server
  • Updating Copyright
• Changelog
  • 0.13.0 (2019-08-12)
  • 0.12.1 (2018-09-28)
  • 0.12.0 (2018-09-27)
  • 0.11.0 (2018-05-16)
  • 0.10.1 (2017-03-04)
  • 0.10.0 (2017-02-12)
  • 0.9.2 (2016-04-22)
  • 0.9.1 (2016-04-22)
  • 0.9.0 (2016-02-22)
  • 0.8.6 (2015-12-26)
  • 0.8.5 (2015-12-12)
  • 0.8.4 (2015-12-07)
  • 0.8.3 (2015-12-05)
  • 0.8.2 (2015-12-01)
  • 0.8.1 (2015-11-27)
  • 0.8.0
  • 0.7.2
  • 0.7.1
  • 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