flask_apispec_rest_endpoint_with_marshmallow_validation_swagger_docs.py

1from flask import Flask
2from flask_apispec import FlaskApiSpec, use_kwargs, marshal_with
3from marshmallow import Schema, fields
4
5app = Flask(__name__)
6
7# Manually define a Schema for validation and documentation
8class PetSchema(Schema):
9    name = fields.Str(required=True)
10    type = fields.Str()
11
12@app.route('/pets/<pet_id>')
13@use_kwargs(PetSchema, location='query')
14@marshal_with(PetSchema)
15def get_pet(pet_id, **kwargs):
16    # This view is validated: it will only proceed if 'name' is in the query string
17    return {'name': kwargs['name'], 'type': 'unknown'}
18
19# Register the documentation
20docs = FlaskApiSpec(app)
21docs.register(get_pet)
22
23if __name__ == '__main__':
24    app.run(debug=True)