Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip
iconfalse

Short version - tl;dr

This section is a very brief summary of the most important things from the sections below. Here we will not go into details but mention the most important points. 

  • Set up Magnolia with version 5.6 or higher, you may want to use a preconfigured Magnolia bundle.
  • Make sure the bundle contains at least the Magnolia REST modules magnolia-rest-integrationmagnolia-rest-servicesmagnolia-rest-content-delivery. ( (version 2.0 or higher). See REST module - Installing if you need help.)
  • Design a security concept with custom users to access the REST endpoint.
    Right now and for testing reasons - use superuser on the author and anonymous user on the public context - at your own risk.
  • Provide a YAML configuration to enable usage of the Delivery endpoint in a Light module.

    Expand
    titleClick here to expand to get a version to start


    Code Pro
    languageyaml
    titledelivery-base-definition.yaml
    linenumberstrue
    class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
    params:
      website:
        depth: 2
        nodeTypes:
          - mgnl:page
          - mgnl:area
          - mgnl:component
        childNodeTypes:
          - mgnl:area
          - mgnl:component
        rootPath: /
        includeSystemProperties: false

    Read Delivery endpoint API - YAML configuration for further details.


  • Get a REST:cURL

    Code Pro
    curl -X GET 'http://localhost:8080/magnoliaPublic/.rest/delivery/website/v1/travel/about'

    and

    Mgnl get
    a REST.

Setup

We assume you are using Magnolia bundle with version 5.6 or higher and you know how you can:

...