FRAMEWORK » FLASK » RESTX

Swagger

Last updated:
Reference:flask-restx.readthedocs.io
Package:pypi

Decorators ​

Route definition ​

Endpoint with no arguments:

py
@api.route('/tasks')

Endpoint that requires an argument (available converters):

py
@api.route('/tasks/<string:name>')

Input ​

py
@api.doc()       # Additional information
@api.response()  # Same as @api.doc(responses='...')
@api.expect()    # Expected input parameters

Output ​

py
@api.marshal_with()  # Expected return values, code, description
@api.header()        # Response header

Models ​

py
api.model()