Page History

...

cd ~/dev/mgnl-rest-test-base

mgnl jumpstart

mgnl-rest-test-base/
├── apache-tomcat
├── light-modules
└── magnolia.zip

cd ~dev/mgnl-rest-test-base
mgnl start

cd ~dev/mgnl-rest-test-base
mgnl start

Anchor
security security

Security settings

We have warned you

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

Using superuser

...

 in the author

...

instance - for testing

...

purposes only

...

On In the author context the superuser is grantedinstance, superuser has:

• Read/Write access for the path / on every JCR workspace - workspace, granted by the role   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.

Note that superuser is given a lot of power. Use it carefully in the context of this tutorial.  But never use superuser on a productive environment.

Using anonymous

...

 in the public

...

instance

The public context instance is typically is visited by users which who do not authenticate. Nevertheless, such These visits are done as as the anonymous user - which , who also has some permissions.

On In the public context anonymous user is grantedinstance, anonymous user has:

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

  Mgnl get

   on the path  path method GET  for the path /magnoliaAuthor/.rest/delivery/*

As you can see, anonymous user only has read access and can only access the Delivery endpoint. That is sufficient for the moment.

On In a productive environment - we highly recommend to recommend you create custom REST roles granting specific access for specific use cases.

...

REST endpoints - an overview

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

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

You can also create your own custom endpoints - for inspiration see How to create a custom Java based REST endpoint. 

Tools to test REST requests

On In this section, we propose suggest some tools you can use to test the REST API - without the need needing to develop a REST consuming client application. Testing your REST requests is handy useful when you are developing client apps and similar things which will that interact with the REST endpoints.

...

Browsers

...