JSON API Extras

Categories

Decoupled

Component ID

2873823

Component name

JSON API Extras

Component type

module

Maintenance status

Actively maintained

Development status

Under active development

Component security advisory coverage

covered

Downloads

3665

Component created

Component changed

Component body

The JSON API module 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 module.

Use JSON API Extras to customize an API generated by the 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 the development version 8.x-1.x-dev of the JSON API module.
  2. Install the JSON API Extras module.
  3. Visit /admin/config/services/jsonapi to overwrite and configure your API.

Integrations

The JSON API Defaults module allows you to specify default parameters for your resource collections.

Component url

https://www.drupal.org/project/jsonapi_extras