Setup

Installation

To install Site Studio JSON:API integration submodule, run the following command on your environments CLI:

composer require acquia/sitestudio_jsonapi

Alternatively download the module from the public github repository acquia/sitestudio_jsonapi by means of your choice. If downloading manually, please make sure to download the dependencies of the module which at the time of writing are the following:

• jsonapi_extras version 3.24 of later

Once Site Studio JSON:API submodule and it's dependencies are downloaded manually, follow the Drupal documentation to install the "Site Studio JSON:API" (`sitestudio_jsonapi) module.

Module ships with default configuration and no additional steps are required. Included configuration enables JSON:API Extras field overrides for "Cohesion Layout Canvas" entity resource - "styles" and "templates" field values are removed from output, "json_values" field is processed using "Cohesion Layout (Site Studio Layout Canvas field)" field enhancer plugin.

Please make sure "Cohesion Layout (Site Studio Layout Canvas field)" field enhancer is applied only on `cohesion_layout--cohesion_layout` resource and should not be applied to any other resouree. Doing so will result in unexpected behaviour and PHP Exception errors.