Skip to main content

Flask + marshmallow for beautiful APIs

Project description

https://travis-ci.org/sloria/flask-marshmallow.png?branch=master

Flask + marshmallow for beautiful APIs

Flask-Marshmallow is a thin integration layer for Flask and marshmallow that adds additional features to marshmallow, including URL and Hyperlinks fields for HATEOAS-ready APIs.

from myapp.database import Model, Integer, String, DateTime
from flask_marshmallow import Serializer, fields, pprint

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

class UserMarshal(Serializer):

    class Meta:
        # Fields to expose
        fields = ('email', 'date_created', '_links')

    _links = fields.Hyperlinks({
        # Same params as Flask.url_for, but args can be attribute names
        # surrounded by < >
        'self': fields.URL('author_detail', id='<id>'),
        'collection': fields.URL('authors')
    })

user = User(email='fred@queen.com', password='secret')
user.save()

serialized = UserMarshal(user)
pprint(serialized.data)
# {
#     "email": "fred@queen.com",
#     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
#     "_links": {
#         "self": "/api/authors/42",
#         "collection": "/api/authors/"
#     }
# }

Get it now

pip install flask-marshmallow

License

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

Changelog

0.1.0-pre (unreleased)

  • First release.

Project details


Release history Release notifications

History Node

0.9.0

History Node

0.8.0

History Node

0.7.0

History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

History Node

0.5.1

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.0

This version
History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
flask_marshmallow-0.1.0-py2.py3-none-any.whl (7.5 kB) Copy SHA256 hash SHA256 Wheel 2.7 Apr 26, 2014
flask-marshmallow-0.1.0.tar.gz (5.1 kB) Copy SHA256 hash SHA256 Source None Apr 26, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page