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. It also (optionally) integrates with Flask-SQLAlchemy.
Get it now
pip install flask-marshmallow
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("user_detail", 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()
result = users_schema.dump(all_users)
return jsonify(result.data)
# OR
# return user_schema.jsonify(all_users)
@app.route("/api/users/<id>")
def user_detail(id):
user = User.get(id)
return user_schema.jsonify(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.
Project Links
License
MIT licensed. See the bundled LICENSE file for more details.
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
flask-marshmallow-0.10.1.tar.gz
(33.0 kB
view hashes)
Built Distribution
Close
Hashes for flask_marshmallow-0.10.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4f507f883838b397638a3a36c7d36ee146b255a49db952f5d9de3f6f4522e8a8 |
|
| MD5 | 567fd24a7c5233e4c82f986f687d40bd |
|
| BLAKE2b-256 | 684e7456ef40aeb59e6332e7481705e2b2f27b01772710d9ea1839c2f6379dc2 |
