JSON API 1.0 (https://jsonapi.org) formatting with marshmallow
Project description
Homepage: http://marshmallow-jsonapi.readthedocs.io/
JSON API 1.0 (https://jsonapi.org) formatting with marshmallow.
marshmallow-jsonapi provides a simple way to produce JSON API-compliant data in any Python web framework.
from marshmallow_jsonapi import Schema, fields
class PostSchema(Schema):
id = fields.Str(dump_only=True)
title = fields.Str()
author = fields.Relationship(
'/authors/{author_id}',
related_url_kwargs={'author_id': '<author.id>'},
)
comments = fields.Relationship(
'/posts/{post_id}/comments',
related_url_kwargs={'post_id': '<id>'},
# Include resource linkage
many=True, include_resource_linkage=True,
type_='comments'
)
class Meta:
type_ = 'posts'
strict = True
post_schema = PostSchema()
post_schema.dump(post).data
# {
# "data": {
# "id": "1",
# "type": "posts"
# "attributes": {
# "title": "JSON API paints my bikeshed!"
# },
# "relationships": {
# "author": {
# "links": {
# "related": "/authors/9"
# }
# },
# "comments": {
# "links": {
# "related": "/posts/1/comments/"
# }
# "data": [
# {"id": 5, "type": "comments"},
# {"id": 12, "type": "comments"}
# ],
# }
# },
# }
# }Installation
pip install marshmallow-jsonapi
Documentation
Full documentation is available at https://marshmallow-jsonapi.readthedocs.io/.
Requirements
Python >= 2.7 or >= 3.5
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
marshmallow-jsonapi-0.20.4.tar.gz
(34.3 kB
view hashes)
Built Distribution
Close
Hashes for marshmallow-jsonapi-0.20.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 120f6ef37b48723f2d32310de923ee44b1358c1962bd1e7aa585f6cf21f6c8cc |
|
| MD5 | 90a4050401c981de594f568385cbf185 |
|
| BLAKE2b-256 | b480b45529f47cf2d4a9f8238da7f77c67b3fc5ecd3516d98ad094ccb5488aa9 |
Close
Hashes for marshmallow_jsonapi-0.20.4-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8944bf3afc8d521b252b4bc1e6f9bca88d19567a5ce7dd54e836927ec2c4ad08 |
|
| MD5 | b9d8044921efeec13e4d288ab8c1af5b |
|
| BLAKE2b-256 | f73b2dee15379cd9b5c3b56a9055e2623f6068804195fecef019e8cdfcf7ae99 |
