DB agnostic framework to build auto-documented REST APIs with Flask and marshmallow
=============
.. image:: https://img.shields.io/pypi/v/flask-smorest.svg :target: https://pypi.org/project/flask-smorest/ :alt: Latest version
.. image:: https://img.shields.io/pypi/pyversions/flask-smorest.svg :target: https://pypi.org/project/flask-smorest/ :alt: Python versions
.. image:: https://img.shields.io/badge/marshmallow-3-blue.svg :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html :alt: marshmallow 3 only
.. image:: https://img.shields.io/badge/OAS-2%20|%203-green.svg :target: https://github.com/OAI/OpenAPI-Specification :alt: OpenAPI Specification 2/3 compatible
.. image:: https://img.shields.io/pypi/l/flask-smorest.svg :target: https://flask-smorest.readthedocs.io/en/latest/license.html :alt: License
.. image:: https://dev.azure.com/lafrech/flask-smorest/apis/build/status/marshmallow-code.flask-smorest?branchName=master :target: https://dev.azure.com/lafrech/flask-smorest/build/latest?definitionId=1&branchName=master :alt: Build status
.. image:: https://img.shields.io/azure-devops/coverage/lafrech/flask-smorest/1 :target: https://dev.azure.com/lafrech/flask-smorest/_build/latest?definitionId=1&branchName=master :alt: Code coverage
.. image:: https://readthedocs.org/projects/flask-smorest/badge/ :target: http://flask-smorest.readthedocs.io/ :alt: Documentation
flask-smorest (formerly known as flask-rest-api) is a REST API framework built upon
Flask_ and
marshmallow_.
Schema
ReDoc_ or
Swagger UI_
::
pip install flask-smorest
flask-smorest supports Python >= 3.6.
Full documentation is available at http://flask-smorest.readthedocs.io/.
If you'd like to support the future of the project, please consider contributing to marshmallow's Open Collective:
.. image:: https://opencollective.com/marshmallow/donate/button.png :target: https://opencollective.com/marshmallow :width: 200 :alt: Donate to our collective
MIT licensed. See the
LICENSE_ file for more details.