Skip to main content

Flask + marshmallow for beautiful APIs

Project description

Latest version Build status Documentation marshmallow 3|4 compatible

Flask + marshmallow for beautiful APIs

Flask-Marshmallow is a thin integration layer for Flask (a Python web framework) and marshmallow (an object serialization/deserialization library) that adds additional features to marshmallow, including URL and Hyperlinks fields for HATEOAS-ready APIs. It also (optionally) integrates with Flask-SQLAlchemy.

Get it now

pip install flask-marshmallow

Create your app.

from flask import Flask
from flask_marshmallow import Marshmallow

app = Flask(__name__)
ma = Marshmallow(app)

Write your models.

from your_orm import Model, Column, Integer, String, DateTime


class User(Model):
    email = Column(String)
    password = Column(String)
    date_created = Column(DateTime, auto_now_add=True)

Define your output format with marshmallow.

class UserSchema(ma.Schema):
    email = ma.Email()
    date_created = ma.DateTime()

    # Smart hyperlinking
    _links = ma.Hyperlinks(
        {
            "self": ma.URLFor("user_detail", values=dict(id="<id>")),
            "collection": ma.URLFor("users"),
        }
    )


user_schema = UserSchema()
users_schema = UserSchema(many=True)

Output the data in your views.

@app.route("/api/users/")
def users():
    all_users = User.all()
    return users_schema.dump(all_users)


@app.route("/api/users/<id>")
def user_detail(id):
    user = User.get(id)
    return user_schema.dump(user)


# {
#     "email": "fred@queen.com",
#     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
#     "_links": {
#         "self": "/api/users/42",
#         "collection": "/api/users/"
#     }
# }

http://flask-marshmallow.readthedocs.io/

Learn More

To learn more about marshmallow, check out its docs.

License

MIT licensed. See the bundled LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_marshmallow-1.3.0.tar.gz (40.9 kB view details)

Uploaded Source

Built Distribution

flask_marshmallow-1.3.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file flask_marshmallow-1.3.0.tar.gz.

File metadata

  • Download URL: flask_marshmallow-1.3.0.tar.gz
  • Upload date:
  • Size: 40.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for flask_marshmallow-1.3.0.tar.gz
Algorithm Hash digest
SHA256 27a35d0ce5dcba161cc5f2f4764afbc2536c93fa439a793250b827835e3f3be6
MD5 7496bced9c3196a9382695504326daf1
BLAKE2b-256 6691f3893613c3a388a643f8a96e1b08a17b863fcc03beb6f2a40bb224da7df7

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_marshmallow-1.3.0.tar.gz:

Publisher: build-release.yml on marshmallow-code/flask-marshmallow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flask_marshmallow-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_marshmallow-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a0644b46406851873ab41c1e8a7de3ef27fa69b00b89bf630f1696ec0813a0
MD5 bc14f51751d3326d28e0e8cb12bbcf8d
BLAKE2b-256 27cd5b3d4103460766eb834f6deaf26a87a4735a0c9687f24163e07d1f3d7791

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_marshmallow-1.3.0-py3-none-any.whl:

Publisher: build-release.yml on marshmallow-code/flask-marshmallow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page