Skip to main content

Flask + marshmallow for beautiful APIs

Project description

Latest version https://travis-ci.org/marshmallow-code/flask-marshmallow.png?branch=pypi

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.

Create your app.

from flask import Flask, jsonify
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('author_detail', id='<id>'),
        'collection': ma.URLFor('authors')
    })

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

Output the data in your views.

@app.route('/api/users/')
def users():
    all_users = User.all()
    result = users_schema.dump(all_users)
    return jsonify(result.data)

@app.route('/api/users/<id>')
def user_detail(id):
    user = User.get(id)
    result = user_schema.dump(user)
    return jsonify(result.data)
# {
#     "email": "fred@queen.com",
#     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
#     "_links": {
#         "self": "/api/authors/42",
#         "collection": "/api/authors/"
#     }
# }

Learn More

To learn more about marshmallow, check out its docs.

Get it now

pip install flask-marshmallow

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

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-0.5.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

flask_marshmallow-0.5.0-py2.py3-none-any.whl (9.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flask-marshmallow-0.5.0.tar.gz.

File metadata

File hashes

Hashes for flask-marshmallow-0.5.0.tar.gz
Algorithm Hash digest
SHA256 ef0b6c5a1b6acad44aa2988cd807e09e76bcdf52ec72fb05aac36b982b11b36d
MD5 62461ec600303d10c3e57bacac1157a3
BLAKE2b-256 280eb5ce477aa37ce9e22216f61f82cbcf5e0442ccff4420904f644381b113bb

See more details on using hashes here.

Provenance

File details

Details for the file flask_marshmallow-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flask_marshmallow-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3db10f461498f564cca8e87a31cfe8dd37d4e15f6728b2cca63c5ece7ee33c42
MD5 ada38c8a72737cdb6d60e84a74ca7c2d
BLAKE2b-256 b2022d75ef9269a4db3bc7302b0d6c45309d099d2865061666a10617f74f93c6

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