I have a Drupal 8 site that is using a bunch of custom views with REST endpoints. These views contain a bunch of content nodes on them which make up a single page.

I have been able to generate an XML sitemap of the views by using Simple XML Sitemap module but I am wanting to know if (and how) it's possible to generate a JSON sitemap of all the views and the paths that are associated with REST but dynamically?

closed as unclear what you're asking by leymannx, mradcliffe, Mario Steinitz, sanzante, prkos Mar 24 at 14:27

Please clarify your specific problem or add additional details to highlight exactly what you need. As it's currently written, it’s hard to tell exactly what you're asking. See the How to Ask page for help clarifying this question. If this question can be reworded to fit the rules in the help center, please edit the question.

  • How would that JSON sitemap look like, basically? Please update your question to add sample output. – leymannx Mar 12 at 6:58

Create a simple custom REST resource in a custom module and within the resource you can return a list of views and other relevant information

Here is a get() function that returns views that are enabled and their displays

 * Responds to entity GET requests.
 * @return \Drupal\rest\ResourceResponse
public function get() {

    $entity_ids = \Drupal::service('entity.query')
        ->condition('status', TRUE)

    $views = [];        
    foreach (\Drupal::entityManager()
        ->loadMultiple($entity_ids) as $view) {

        $displays = [];
        // Check each display to see if it meets the criteria and is enabled.
        foreach ($view->get('display') as $id => $display) {

            // If the key doesn't exist, enabled is assumed.
            $enabled = !empty($display['display_options']['enabled']) || !array_key_exists('enabled', $display['display_options']);
            if ($enabled ) {
                $displays[] = [
                    'id' => $display['id'],
        $views[] = [
            'view_id' => $view->id(),
            'displays' => $displays,

    $response = new ResourceResponse($views);
    return $response;

You can modify the views array using the for loops to display any information that you find relevant to your task.

Here is a working demo module that I did for the sake of this exercise

Not the answer you're looking for? Browse other questions tagged or ask your own question.