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¶
This part of the documentation will show you how to get started in using Flask-RESTPlus 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 autorizations
- Export Swagger specifications
- Swagger UI
- Documenting with the
- 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.