flask-apispec is a lightweight tool for building REST APIs in Flask. flask-apispec uses webargs for request parsing, marshmallow for response formatting, and apispec to automatically generate Swagger markup. You can use flask-apispec with vanilla Flask or a fuller-featured framework like Flask-RESTful.
pip install flask-apispec
from flask import Flask from flask_apispec import use_kwargs, marshal_with from marshmallow import fields, Schema from .models import Pet app = Flask(__name__) class PetSchema(Schema): class Meta: fields = ('name', 'category', 'size') @app.route('/pets') @use_kwargs({'category': fields.Str(), 'size': fields.Str()}) @marshal_with(PetSchema(many=True)) def get_pets(**kwargs): return Pet.query.filter_by(**kwargs)flask-apispec works with function- and class-based views:
from flask import make_response from flask_apispec.views import MethodResource class PetResource(MethodResource): @marshal_with(PetSchema) def get(self, pet_id): return Pet.query.filter(Pet.id == pet_id).one() @use_args(PetSchema) @marshal_with(PetSchema, code=201) def post(self, data): return Pet(**data) @use_kwargs(PetSchema) @marshal_with(PetSchema) def put(self, pet_id, **kwargs): pet = Pet.query.filter(Pet.id == pet_id).one() pet.__dict__.update(**kwargs) return pet @marshal_with(None, code=204) def delete(self, pet_id): pet = Pet.query.filter(Pet.id == pet_id).one() pet.delete() return make_response('', 204)flask-apispec generates Swagger markup for your view functions and classes. By default, Swagger JSON is served at /swagger/, and Swagger-UI at /swagger-ui/.
from apispec import APISpec from apispec.ext.marshmallow import MarshmallowPlugin from flask_apispec.extension import FlaskApiSpec app.config.update({ 'APISPEC_SPEC': APISpec( title='pets', version='v1', plugins=[MarshmallowPlugin()], ), 'APISPEC_SWAGGER_URL': '/swagger/', }) docs = FlaskApiSpec(app) docs.register(get_pets) docs.register(PetResource)https://flask-apispec.readthedocs.io/
flask-apispec is strongly inspired by Flask-RESTful and Flask-RESTplus, but attempts to provide similar functionality with greater flexibility and less code.