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:
- Enable and disable resources.
- Overwrite the name of a resource. Example:
article
instead ofnode--article
. - Overwrite the path for a resource: Example:
/api/articles
instead of/jsonapi/node/article
. - Disable fields.
- Use field aliases. Example:
tags
instead offield_tags
. - Enhance field output. Example: Use the
date_time
field enhancer to format date fields.
Installation
- Install and enable the JSON:API Extras module.
- 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:
Project information
- Module categories: Decoupled
- Ecosystem: JSON:API
- 19,554 sites report using this module
- Created by e0ipso on , updated
- Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.
Releases
Development version: 8.x-3.x-dev updated 20 Oct 2023 at 11:42 UTC