JSON:API Explorer

The JSON:API Explorer is an interactive web application for exploring your JSON:API server.

Dependencies

Drupal core 8.8 or above
JSON:API Schema
JSON:API Hypermedia

The explorer SPA is always publicly available at https://explore.jsonapi.dev and using it is a great way to explore live JSON:API servers or try out an example JSON:API server.

However, there are three limitations to using the public explorer for your own applications:

1. Your JSON:API server must be served over HTTPS
2. https://explore.jsonapi.dev must be added to your CORS settings
3. You cannot use the explorer for authenticated requests

This module provides a very simple workaround to all three of those limitations. This module provides a route on your Drupal site at /jsonapi/explorer/app. When you visit that URL, Drupal will make a request to https://explorer.jsonapi.dev and forward the response to your browser under the same origin as your Drupal site—proxying all JS and CSS assets.

That means that with this module:

• You will never need to update this module to get the latest explorer features
• You will not need to make any changes to your CORS settings
• You will not need to set up HTTPS (this is especially valuable when working locally)