Skip to main content

Flask + marshmallow for beautiful APIs

Project description

Latest version Build status Documentation marshmallow 3 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):
    class Meta:
        # Fields to expose
        fields = ("email", "date_created", "_links")

    # 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.2.1.tar.gz (40.8 kB view details)

Uploaded Source

Built Distribution

flask_marshmallow-1.2.1-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flask_marshmallow-1.2.1.tar.gz
  • Upload date:
  • Size: 40.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for flask_marshmallow-1.2.1.tar.gz
Algorithm Hash digest
SHA256 00ee96399ed664963afff3b5d6ee518640b0f91dbc2aace2b5abcf32f40ef23a
MD5 390010c2e3b7a05a72b7c9dcd8a39315
BLAKE2b-256 bf9c0c0cee00441981502358b4bc6e3d1b21247d3d80a277dde18bf3d0ad7426

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for flask_marshmallow-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 10b5048ecfaa26f7c8d0aed7d81083164450e6be8e81c04b3d4a586b3f7b6678
MD5 ddc3c5699abc420a5fd306be8dd5ccca
BLAKE2b-256 6858b20b1c8e3174479ea23388d61a9772132586ff492a280acbc84082a2a176

See more details on using hashes here.

Provenance

Supported by

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