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).
Compatibility¶
flask-restx requires Python 2.7+.
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
- Response marshalling
- Request Parsing
- Error handling
- Fields masks
- 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
- Documenting with the
- Logging
- Postman
- Scaling your project
- 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.