The JSON:API Hypermedia module is complementary component of the JSON:API module.

It adds support for rich, dynamic linking between your application's resources. It does not add any links of its own. Instead, it provides a plugin system for other modules to leverage.

This module enables other modules to provide useful links that drive a client's interaction with your JSON:API application. For a more in-depth dive understanding of why customizable links are so important and how they can be so valuable, check out this video: The REST and then some or read this blog post.

Here are some of things that are achievable once JSON:API Hypermedia is installed:

  • Providing menu content and aliased URLs
  • Providing custom operations like "add to cart", "like", "unlike", etc.
  • Providing custom labels for "call to action" buttons.
  • Providing "breadcrumbs".
  • What operations can I perform on a resource (like add, update or remove)?
  • Which of those operations is the client permitted to access?
  • Providing metadata about linked resources (like the list of available languages or the price of a product variation).
Supporting organizations: 
Research & development

Project information

Releases