Page History

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. 

...

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

...

-proyaml

The above example requires the Magnolia specific !inherit directive available since Magnolia 5.5.6

Note that you can extend the default freemarker renderer.

Code Block
language	yml title /module-a/renderers/json.yaml url https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/renderers/json.yaml?at=master
Localtab
title JCR node
Advanced Tables - Table Plus
enableHeadingAttributes false enableSorting false class m5-configuration-tree enableHighlighting false
Node name	Value
Mgnl f modules	Mgnl f rendering	Mgnl f renderers	Mgnl n json
Mgnl p contentType	application/json
Mgnl p extends	../freemarker
Mgnl p type	json

Template definition

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.

[#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: 

If you want to use a RESTful URL instead:

Add the following virtual URI mapping:

...

...

Node name

...

Value

...

...

...

...

...

...

...

...

!inherit:freemarker
contentType: application/json

Template definition

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.

[#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: 

If you want to use a RESTful URL instead:

Add the following virtual URI mapping:

Image Added

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).

...

...