Page History

 This beginner's tutorial is intended for developers who want to start using Magnolia REST features.

Getting content with REST - examples

Look at the following examples of how to get content from our public demo using our out-of-the-box REST API.

Anchor
setup setup

Setting up Magnolia for REST

In this section you use Magnolia CLI to install and start a preconfigured Magnolia bundle with the required modules for Magnolia REST features.

If you do not have Magnolia CLI, install it as described here.

Then install Magnolia as follows:

1. Change to the directory to where you want to install the Magnolia bundle. In our example, we use the directory ~/dev/mgnl-rest-test:

   Code Block
   cd ~/dev/mgnl-rest-test

2. Execute the Magnolia CLI jumpstart command to get Magnolia and choose the  magnolia-community-demo-bundle when prompted:

   Code Block
   mgnl jumpstart

   Jumpstart downloads and extracts the magnolia-community-demo-bundle that comes with Tomcat server. 

   The following files and folders are created:

   Code Block
   language text
   mgnl-rest-test/ ├── apache-tomcat ├── downloads └── light-modules

3. Go to the ~dev/mgnl-rest-test directory and execute the Magnolia CLI start command:

   Code Block
   mgnl start

   When starting for the first time, Magnolia runs a web update and automatically installs all its modules.

4. In your preferred browser, open the URL http://localhost:8080/magnoliaAuthor/ and log in as user superuser with the password superuser.

5. Have a look around Magnolia. Access the public instance with the URL http://localhost:8080/magnoliaPublic/.

Anchor
security security

Security settings

In the context of this tutorial and to get started quickly, we use users with roles provided by the default setup of the Magnolia bundle:

• superuser in the author instance has:

• • Read/Write access for the path / on every JCR workspace, granted by the  superuser role.

  • Web access for the HTTP methods 

    Mgnl get

    , 

    Mgnl put

    , 

    Mgnl post

     and 

    Mgnl delete

     for the path /magnoliaAuthor/.rest*  granted by the role rest-admin.

• anonymous (unauthenticated user) in the public instance has:

  • Read access on the path / for the JCR workspaces website, dam, googleSitemaps, category, and tours.

  • Web access for the HTTP method GET  for the path /magnoliaAuthor/.rest/delivery/*

Before enabling and using the REST endpoints in a production environment, you must read and understand REST security.

Using the delivery endpoint

The delivery endpoint is a REST API provided by Magnolia out-of-the-box. Use it for obtaining JCR data as JSON. 

With version 2 of the delivery endpoint API, you can define multiple endpoint configurations, deliver localized content and resolve references to nodes of other workspaces including assets and asset renditions. You must provide at least one endpoint configuration to use the delivery API. 

Configuring the delivery endpoint

We will create a light module to provide the YAML-based configuration required for the delivery endpoint. 

Note that the folder structure and endpoint definition configuration file names you create now may later be used as the value of the endpointPath property. The endpoint path is used as part of the URL so we recommend you think ahead when naming your files.

In your light-modules folder, which is configured with the property magnolia.resources.dir, create the following structure:

define-delivery-endpoint/
└── restEndpoints/
    └── delivery/
        └── demo-content.yaml

You can use this code to start with for the demo-content.yaml file:

class: info.magnolia.rest.delivery.jcr.v2.JcrDeliveryEndpointDefinition
workspace: website
depth: 2
nodeTypes:
  - mgnl:page
  - mgnl:area
  - mgnl:component
childNodeTypes:
  - mgnl:area
  - mgnl:component
includeSystemProperties: false

You can find a full explanation of the properties on Delivery endpoint API configuration.

Reading website content with the delivery endpoint

With the configuration provided above, you are ready to send REST requests to your Magnolia instance.

We will fetch the content of the page /travel/about on the website workspace. Have a look at Delivery endpoint API - readNode to understand how to compose the URL. We need:

• The endpoint path: in our case evaluated by the system as  delivery/demo-content .
• The relative path of the node: travel/about.

URL => /.rest/delivery/demo-content/travel/about

Now add the "context" (the name of the webapp), the domain and the protocol, and you get these URLs:

• http://localhost:8080/magnoliaPublic/.rest/delivery/demo-content/travel/about
• http://localhost:8080/magnoliaAuthor/.rest/delivery/demo-content/travel/about

You can request the first URL, which goes to the public instance, with the browser as the anonymous user (without authentication). For the second URL, you must authenticate.

To test these URLs with cURL, use the following commands:

curl -X GET 'http://localhost:8080/magnoliaPublic/.rest/delivery/demo-content/travel/about'

curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/demo-content/travel/about' \
-u superuser:superuser

Anchor
anc-restendpointsoverview anc-restendpointsoverview

REST endpoints overview

Magnolia provides the following REST endpoints out-of-the-box:

If you want to use REST to create, update and delete content, we recommend you use the Nodes endpoint which supports all required operations. If you mainly want to read data, consider using the Delivery endpoint. It provides convenient, formatted JSON and can be customized and configured with YAML using light modules. With the Commands endpoint you can trigger commands and Cache endpoint deals with cache. 

Further reading

• Tools to test REST requests

• REST API

• How to add an asset with REST

• How to create a custom Java-based REST endpoint. 

This page explains how to get started using the Magnolia REST features. We will show how to setup Magnolia in order to use all the REST functions provided my Magnolia. We quickly explain the available REST endpoints. And we give you an idea how you can test and use these endpoints.

Short version - all in 10' 

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

Setup

We assume you are using Magnolia bundle with version 5.6 or higher and you know how you can install and start Magnolia; otherwise please refer to Installing Magnolia.

Required modules

These three modules listed below are required to use all Magnolia REST features within a productive context. 

• magnolia-rest-integration
• magnolia-rest-services
• magnolia-rest-content-delivery

When using a preconfigured preconfigured Magnolia bundle - your webapp(s) already contain(s) these three modules. When using a custom webapp or bundle, make sure your custom setup contains the  module listed above. See REST module - Installing if you need help to install the Magnolia REST modules.

While developing new features, it can be helpful to use the magnolia-rest-tools which enable the swagger UI tools. Have a look at the next section.

Enabling swagger UI tools

La la la 

<TODO: add more here ...>

Security settings

...

Testing the setup

...

The endpoints - an overview

...

My first REST request

..

...