Page History
| HTML Wrap | ||||
|---|---|---|---|---|
| ||||
Related topics: |
This page provides an overview of the different ways of retrieving JSON for JCR-based content in Magnolia as well as listing their respective advantages and disadvantages.
...
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
This result is returned for the endpoint called
|
Pros
- Convenient and simple to use JSON structure.
- Supports RESTful URLs.
- Highly configurable via YAML file in a light module or in the JCR
configurationworkspace. - Supports multiple endpoint configurations to serve different needs.
- Provides a fine-grained security.
- Supports localization.
- Can resolve referenced nodes from other workspaces,including image renditions, within one request.
...
However, having the "proper" content type may not be required. In many use cases it is sufficient to use the FreeMarker renderType that responds with text/html .
Renderer configuration
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| yaml
| |||||||
| Localtab | ||||||||
| ||||||||
| Advanced Tables - Table Plus | ||||||||
| ||||||||
Node name | Value |
|
|
|
| |||
| application/json | |||||||
| ../freemarker | |||||||
| json |
Template definition
| Code Pro |
|---|
title: jsonprovider0815
templateScript: /ftl-json-provider/templates/pages/jsonprovider0815.ftl
renderType: json
#renderType: freemarker
visible: true |
Turning a template-based JSON provider into a RESTful API with virtualURIMapping
You can create a template that accepts request parameters to specify the JSON content to be returned. In the example below, you can specify the workspace and the path of the node.
!inherit:freemarker
contentType: application/json |
Template definition
| Code Pro |
|---|
title: jsonprovider0815
templateScript: /ftl-json-provider/templates/pages/jsonprovider0815.ftl
renderType: json
#renderType: freemarker
visible: true |
Turning a template-based JSON provider into a RESTful API with virtualURIMapping
You can create a template that accepts request parameters to specify the JSON content to be returned. In the example below, you can specify the workspace and the path of the node.
| Code Pro |
|---|
[#assign path = ctx.path!"undefined" /]
[#assign workspace = ctx.workspace!"tours" /]
[#assign response = '{ "error" : "Missing path parameter." }' /]
[#if path!="undefined"]
[#assign contentNode = cmsfn.contentByPath(path, workspace)]
[#assign response = jsonfn.from(contentNode).add("@path", "name", "description").wrapForI18n().print() /]
[/#if]
${response |
| Code Pro |
[#assign path = ctx.path!"undefined" /]
[#assign workspace = ctx.workspace!"tours" /]
[#assign response = '{ "error" : "Missing path parameter." }' /]
[#if path!="undefined"]
[#assign contentNode = cmsfn.contentByPath(path, workspace)]
[#assign response = jsonfn.from(contentNode).add("@path", "name", "description").wrapForI18n().print() /]
[/#if]
${response} |
Create the page with the JSON-providing template at /getjson. You can call it with the following URL:
| Mgnl mini code snippet |
|---|
http://localhost:8080/magnoliaAuthor/getjson? |
If you want to use a RESTful URL instead:
| Mgnl mini code snippet |
|---|
http://localhost:8080/magnoliaAuthor/getjson/tours /magnolia-travels/Kyoto |
Add the following virtual URI mapping:
...
| enableHeadingAttributes | false |
|---|---|
| enableSorting | false |
| class | m5-configuration-tree |
| enableHighlighting | false |
...
Node name
...
Value
...
| Mgnl f |
|---|
...
| Mgnl f |
|---|
...
| Mgnl f |
|---|
...
| Mgnl n |
|---|
...
| Mgnl p |
|---|
...
| Mgnl p |
|---|
...
| Mgnl p |
|---|
...
getjson. You can call it with the following URL:
| Mgnl mini code snippet |
|---|
http://localhost:8080/magnoliaAuthor/getjson? |
If you want to use a RESTful URL instead:
| Mgnl mini code snippet |
|---|
http://localhost:8080/magnoliaAuthor/getjson/tours /magnolia-travels/Kyoto |
Add the following virtual URI mapping:
Pros
- Highly configurable.
- Fully customizable when assembling JSON manually.
- Decent customizable when using jsonfn.
- No Java required.
- Localization support.
- Delivery of personalized variants of pages or components is possible (see personalization).
...
| Multiexcerpt | ||
|---|---|---|
| ||
According to the same-origin policy:
Therefore, if your application resides within a domain that is different from the domain that hosts your data, the web browser will actively prevent accessing content stored under the host domain. An elegant solution to solve the same-origin policy without changing Apache configuration is the Magnolia Add HTTP Headers filter. This fiter filter is available out-of-the-box; you only need to configure it. |
...
Overview
Content Tools