JSON API parser returning a simple Python dictionary
Switch branches/tags
Nothing to show
Clone or download

README.rst

JSON API Doc

Documentation Status Updates

JSON API to document parser. Available as a command line utility and Python 3 module.

This parser will transform JSON API (http://jsonapi.org/) documents to object easier to manipulate.

For this JSON API document:

{
  "data": [{
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "JSON API paints my bikeshed!",
      "body": "The shortest article. Ever.",
      "created": "2015-05-22T14:56:29.000Z",
      "updated": "2015-05-22T14:56:28.000Z"
    },
    "relationships": {
      "author": {
        "data": {"id": "42", "type": "people"}
      }
    }
  }],
  "included": [
    {
      "type": "people",
      "id": "42",
      "attributes": {
        "name": "John",
        "age": 80,
        "gender": "male"
      }
    }
  ]
}

The simplified version will be:

[
    {
        "type": "articles",
        "id": "1",
        "title": "JSON API paints my bikeshed!",
        "body": "The shortest article. Ever.",
        "created": "2015-05-22T14:56:29.000Z",
        "updated": "2015-05-22T14:56:28.000Z",
        "author": {
            "type": "people",
            "id": "42",
            "name": "John",
            "age": 80,
            "gender": "male"
        }
    }
]

Usage as python module

import json_api_doc

document =  {
    'data': {
        'type': 'article,
        'id': '1',
        'attributes': {
            'name': 'Article 1'
        }
    }
}
json_api_doc.parse(document)

Usage as cli

$ jsonapidoc document.json

Licence

Free software: Apache Software License 2.0

Documentation

Full Documentation is available: https://json-api-doc.readthedocs.io.