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
- Syntaxic sugar
- 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
- Marking as deprecated
- Hiding from documentation
- Documenting autorizations
- Documenting with the
- Swagger UI documentation
- Exporting
- Full example
- API
- Changelog