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
- Docs: http://marshmallow-jsonapi.readthedocs.io/
- Changelog: http://marshmallow-jsonapi.readthedocs.io/en/latest/changelog.html
- Contributing Guidelines: https://marshmallow-jsonapi.readthedocs.io/en/latest/contributing.html
- PyPI: https://pypi.python.org/pypi/marshmallow-jsonapi
- Issues: https://github.com/marshmallow-code/marshmallow-jsonapi/issues
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size marshmallow_jsonapi-0.24.0-py2.py3-none-any.whl (14.3 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size marshmallow-jsonapi-0.24.0.tar.gz (34.6 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for marshmallow_jsonapi-0.24.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7403688297dfe8b89173582811989badbe1328ac36447c5a151c006fbe34d24 |
|
MD5 | 2bb6b6293063e12cd7ddcc65176b78af |
|
BLAKE2-256 | b6445cf50d083ac6e1ca654e1cbaab0342b1f231591a3cd184f72827eccfa9f3 |
Close
Hashes for marshmallow-jsonapi-0.24.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd88c0ac0e2ddeb0a3ceb86229963b9f828d898041f29d92a68f585a1feb37b5 |
|
MD5 | 14711955535ee9850ab13f89278a7a2f |
|
BLAKE2-256 | 428e5148bdc8ffb44e03a259ac4c824d568ad9ce2653c63e216382ee94308bc3 |