Part of the Views ecosystem · 286 projects
This module enhances Views REST export displays by including additional metadata in the response, such as total results, pagination information, and available filters. It allows for renaming response keys and specifying a typeahead path, making it ideal for decoupled applications that need comprehensive data for building search interfaces.
This module adds a new Views style plugin to add additional metadata into the response for REST Export displays in Views with the following:
- Result items
- Total results
- Total pages
- Items per page
- Items per page options
- Current page
- Typeahead path for autocompleting inputs
- Available exposed filters
- Available exposed sorts
- Available Facets (from the Facets module)
Additionally, you can toggle Facet inclusion on or off for a given display as well as 'rename' the keys in the response. The latter is useful for matching up with frontend implementations that may not match the default property names in Drupal (for instance "data" instead of "results"). The typeahead path can be provided by Search API Autocomplete or be a custom path in your implementation that returns results to the frontend.
This module is best suited for hybrid or decoupled interfaces that lets them access a Views REST display URL and received a JSON or XML response in return with all the information they would need to build a search interface in React, Vue, or similar. The plugin works for REST export displays only and has been used extensively in Search API / Search API Solr setups.
Using this approach will let you build several frontend components quickly while maintaining a consistent backend via Views and agree on the data contract between the frontend and backend or make quick adjustments from the View itself rather than in code.
Ask your assistant about Views REST Serializer Extra
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
- rest Drupal core
- serialization Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
More in the Views ecosystem
Most installed first
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 1.0.2 | Stable | 9–11 | May 19, 2024 | ||
| 1.0.1 | Stable | 9–10 | Jan 31, 2024 | ||
| 1.0.0 | Stable | 9–10 | Nov 27, 2023 | ||
| 1.0.0-alpha1 | Pre-release | 9–10 | Aug 3, 2023 | ||
| 1.0.x-dev | Dev | 9–11 | Aug 3, 2023 |