JSON:API Extras

The JSON:API module in code provides zero configuration out of the box. Use JSON:API Extras to customize your API. JSON:API Extras provides a means to override and provide limited configurations to the default zero-configuration implementation provided by the JSON:API in Core.

Use JSON:API Extras to customize an API generated by the Core JSON:API module.

Here are the current features of the JSON:API Extras module:

1. Enable and disable resources.
2. Overwrite the name of a resource. Example: article instead of node--article.
3. Overwrite the path for a resource: Example: /api/articles instead of /jsonapi/node/article.
4. Disable fields.
5. Use field aliases. Example: tags instead of field_tags.
6. Enhance field output. Example: Use the date_time field enhancer to format date fields.

Installation

1. Install and enable the JSON:API Extras module.
2. Visit /admin/config/services/jsonapi to overwrite and configure your API.

Integrations

The JSON:API Defaults sub-module allows you to specify default input parameters (include, page[limit] and filter) for your resource collections.

Contenta CMS

This module is part of the Contenta CMS decoupled distribution and integrates with Contenta JS. Learn more about these projects: