Getting started with REST

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

The Swagger framework is supported by a set of core tools for designing, building, and documenting RESTful APIs.

Source: https://swagger.io/tools/

Magnolia provides integration with Swagger tools directly in the Admin UI.

La la la 

<TODO: add more here ...>

Security settings

...

Testing the setup

...

The endpoints - an overview

...

My first REST request

..

Getting familiar with tools