Flask + marshmallow for beautiful APIs
Project description
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.ext.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.
Changelog
0.4.0 (2014-12-22)
Backwards-incompatible: Rename URL and AbsoluteURL to URLFor and AbsoluteURLFor, respectively, to prevent overriding marshmallow’s URL field. Thanks @svenstaro for the suggestion.
Fix bug that raised an error when deserializing Hyperlinks and URL fields. Thanks @raj-kesavan for reporting.
Deprecation:
Schema.jsonify is deprecated. Use flask.jsonify on the result of Schema.dump instead.
The MARSHMALLOW_DATEFORMAT and MARSHMALLOW_STRICT config values are deprecated. Use a base Schema class instead.
0.3.0 (2014-10-19)
Supports marshmallow >= 1.0.0-a.
0.2.0 (2014-05-12)
Implementation as a proper class-based Flask extension.
Serializer and fields classes are available from the Marshmallow object.
0.1.0 (2014-04-25)
First release.
Hyperlinks, URL, and AbsoluteURL fields implemented.
Serializer#jsonify implemented.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file flask-marshmallow-0.4.0.tar.gz.
File metadata
- Download URL: flask-marshmallow-0.4.0.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 245bbdef843503a672f7274eea406a507155ea8e3e4e89e1e6fa3d9e26a4f85a |
|
| MD5 | d1c208f75f8cb198c04794fcffb3f45c |
|
| BLAKE2b-256 | 189906f3e4dc2aecd14a64d741fea6a3c7c659c35e8b0c0e4c4158c3e8ed1f52 |
Provenance
File details
Details for the file flask_marshmallow-0.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: flask_marshmallow-0.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 44258ffb4eeabcbb2caee07b8c8c356f22d1cb9fc67cb0fd85d4ef513b77653b |
|
| MD5 | 4db407e85a13008871aef0685dffb5fc |
|
| BLAKE2b-256 | e6001842fb7b1b05730d397ce0a35477c6f1e4a6ea92d3ba17eb1b0c8c4ec590 |
