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.

Compatibility

flask-restx requires Python 2.7+ or 3.4+.

Installation

You can install flask-restx with pip:

$ pip install flask-restx

or with easy_install:

$ easy_install flask-restx

Documentation

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

• Installation
• Quick start
  • Migrate from Flask-RESTPlus
  • 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-RESTX 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
• Logging
• Postman
• Scaling your project
  • Multiple namespaces
  • Use With Blueprints
  • Multiple APIs with reusable namespaces
• Full example
• Configuration

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
  • Release process
  • Updating Copyright

Indices and tables

• Index

• Module Index

• Search Page