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.
Project 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.21.2.tar.gz
(35.2 kB
view hashes)
Built Distribution
Close
Hashes for marshmallow-jsonapi-0.21.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83e33b41e8f411d34a4b515c39f10192919a9d4f7eeccd4d6b49a4030a163374 |
|
MD5 | 3246dc70436b42b36e3d5b95f53816ee |
|
BLAKE2b-256 | 60b5c64475a3591a0fc8c458c17d9e9ce78e13124caeccb3e646b844b864e33c |
Close
Hashes for marshmallow_jsonapi-0.21.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0d2cb711ed7b852136fa7cd3457c55fabbf343ada1fc406c67b5167a5a26b0f |
|
MD5 | 09afdc25d9d5b33ebd3a09ef9db0f571 |
|
BLAKE2b-256 | c0c1771863b11e3e8552d5f5fe49895a5793a4ae91696da16b9e371218b68ef1 |