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.2.tar.gz
(33.7 kB
view hashes)
Built Distribution
Close
Hashes for marshmallow-jsonapi-0.20.2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ce6fcc1a5392349b40e008b5808fca887ac3069ee855cd19ca69bb76e308b0c |
|
| MD5 | 638ed80e359874c464fccfa0d6b82221 |
|
| BLAKE2b-256 | 47c51c38ba1cd0b8802d63c86a17fd91932dc5545540952298a79ac5490930db |
Close
Hashes for marshmallow_jsonapi-0.20.2-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee61a9f5387bf1fc7e27b59216f37a20b5baeba1755ac7e792dd5d37eb70b8e5 |
|
| MD5 | 8f8c70804489d144352258497a057c25 |
|
| BLAKE2b-256 | 8ae5fb9a815d10d629c3f6a0ede651d1034150b553a9bc73c7250d7d9742fc2a |
