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"
post_schema = PostSchema()
post_schema.dump(post)
# {
# "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 >= 3.6
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.23.2.tar.gz
(35.3 kB
view hashes)
Built Distribution
Close
Hashes for marshmallow-jsonapi-0.23.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5bbf57741c4af21b7d90b04b4e1ffc830032bc89f7f6b8b61fe9eef2efcff93 |
|
MD5 | 82c4a8563db2d9c01bf28569ec2bc04c |
|
BLAKE2b-256 | 5ff6da32f48f8683e7233cf49fc3d8957738d1a5a32dddb3d32df7d72b176a2c |
Close
Hashes for marshmallow_jsonapi-0.23.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bbb5b8413eca253dbe02f04a51aaa406c718661210d86594acfe7152e4e8199 |
|
MD5 | 9d06447175712e5e6666b2f57e601f21 |
|
BLAKE2b-256 | 1c4c13e0502ddb51baec17924e0f8187b4e7a462a7fd9563d6fa3b918e04c93e |