JSON API 1.0 (https://jsonapi.org) formatting with marshmallow
Project description
Homepage: http://marshmallow-jsonapi.rtfd.org/
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_data=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.org/.
Requirements
Python >= 2.7 or >= 3.3
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.4.0.tar.gz
(20.3 kB
view details)
Built Distribution
File details
Details for the file marshmallow-jsonapi-0.4.0.tar.gz.
File metadata
- Download URL: marshmallow-jsonapi-0.4.0.tar.gz
- Upload date:
- Size: 20.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 26bccf192bee95c00544721db3c98d289c90b9c176b56653c26b748c21899dc3 |
|
| MD5 | 7f9bf6a64872cbbd43344728956fe0ce |
|
| BLAKE2b-256 | db7f7114d78505156a255fcd149c2c965145552a77a788fd2b01a11919998a2e |
Provenance
File details
Details for the file marshmallow_jsonapi-0.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: marshmallow_jsonapi-0.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3b0d038fa278733ef33100ed8fa2d688bf7482af49640dd4d02b04b8baf3bc1 |
|
| MD5 | ef3c10399046b0bf5ae6ad91de2d5568 |
|
| BLAKE2b-256 | 23fa67de395c4f686305bd29b04ed0b9642e069e9880f27215ccdf4ce19b752a |
