Skip to content

DB agnostic framework to build auto-documented REST APIs with Flask and marshmallow

License

Notifications You must be signed in to change notification settings

marshmallow-code/flask-smorest

Repository files navigation

flask-smorest

Latest version Python versions marshmallow 3 only OpenAPI Specification 2/3 compatible License Build status Code coverage pre-commit.ci status Documentation

'cause everybody wants s'more

flask-smorest (formerly known as flask-rest-api) is a REST API framework built upon Flask and marshmallow.

Sponsor Message

Input an OpenAPI spec to generate API docs that look as good as Stripe's. Request a preview of your docs on Fern.

Fern logo

Features

  • Serialization, deserialization and validation using marshmallow Schema
  • Explicit validation error messages returned in response
  • Database-agnostic
  • OpenAPI (Swagger) specification automatically generated and exposed with ReDoc, Swagger UI or RapiDoc
  • Pagination
  • ETag

Install

pip install flask-smorest

Documentation

Full documentation is available at http://flask-smorest.readthedocs.io/.

Support flask-smorest

If you'd like to support the future of the project, please consider contributing to marshmallow's Open Collective:

Donate to our collective

License

MIT licensed. See the LICENSE file for more details.