The jsonapi module exposes a JSON API implementation for data stored in Drupal.
The JSON API specification supports extensions. The following extensions are supported in this JSON API implementation:
- Partial Success, for when a resource collection is retrieved and only a subset of resources is accessible.
- Fancy Filters, to specify the filter strategy exposed by this module.
Install the module as every other module.
This module is compatible with Drupal core 8.3.x and higher.
Unlike the core REST module JSON API doesn't really require any kind of configuration by default.
The jsonapi module exposes both config and content entity resources. On top of that it exposes one resource per bundle per entity. The default format appears like: /jsonapi/{entity_type}/{bundle}/{uuid}?_format=api_json
The list of endpoints then looks like the following:
/jsonapi/node/article: Exposes a collection of article content/jsonapi/node/article/{UUID}: Exposes an individual article/jsonapi/block: Exposes a collection of blocks/jsonapi/block/{block}: Exposes an individual block
It is also possible to obtain the JSON API representation of a supported entity:
// For a given $entity object.
$nested_array = \Drupal::service('jsonapi.entity.to_jsonapi')->normalize($entity);
Should it be needed, the raw string itself can be obtained:
// For a given $entity object.
$json_string = \Drupal::service('jsonapi.entity.to_jsonapi')->serialize($entity);