Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleClick to see the resulting JSON


Code Pro
languagejs
linenumberstrue
[
  {
    "@name": "Vietnam--Tradition-and-Today",
    "@path": "/magnolia-travels/Vietnam--Tradition-and-Today",
    "isFeatured": "true",
    "name": "Vietnam: Tradition and Today",
    "description": "Discover the culture and everyday treasures of a rising phoenix",
    "location": "Ho Chi Minh City, Vietnam",
    "tourTypes": [
      "415025c6-e4b5-4506-9384-34f428a52104",
      "e007e401-1bf8-4658-8293-b9c743784264"
    ],
    "author": "Magnolia Travels",
    "body_de": "<p>Vietnam ist eine der exotischsten und kulturreichsten Destinationen weltweit. Als Juwel unter Juwelen bietet es dem Besucher schillernde Vielfalt. Doch was die meisten so faszinierend finden, ist seine F&auml;higkeit zum Wandel. Dies wird nirgends deutlicher als in Ho-Chi-Minh-Stadt. Die am Saigon-Fluss gelegene Gro&szlig;stadt ist das perfekte Beispiel f&uuml;r das Nebeneinander von Fortschritt und Tradition. Pr&auml;chtige Kolonialbauten stehen neben modernen Wolkenkratzern, w&auml;hrend sich japanische Autos mit Fahrradrikschas die stark befahrenen Stra&szlig;en teilen. Wir bringen Sie nicht nur zu den wichtigsten Sehensw&uuml;rdigkeiten, sondern zeigen Ihnen auch die verborgenen Geschichten, die erkl&auml;ren k&ouml;nnen, was Vietnam zu dem macht, was es heute ist, und wohin es geht.</p>\n<p>Eine zweit&auml;gige Tour durch das Mekong-Delta (Vietnamesisch: Đồng Bằng S&ocirc;ng Cuu Long &bdquo;Flussdelta der neun Drachen&ldquo;) taucht Sie in ein Labyrinth des Lebens auf dem Wasser ein, in dem alles auf Booten geschieht, selbst die lokalen M&auml;rkte, die Tag f&uuml;r Tag durch ein Flo&szlig; der Boote der H&auml;ndler gebildet werden. Wir fahren weiter zur K&uuml;stenstadt Vung Tau, um dort im Phuong-Distrikt zu entspannen und wie die Einheimischen zu schwimmen.<br /> W&auml;hrend wir dort sind, besuchen wir den ber&uuml;hmten Wei&szlig;en Palast, die alte historische Kolonialvilla des franz&ouml;sischen Gouverneurs.</p>\n<p>Unterwegs werden Sie mit das beste Essen zu sich nehmen, das Sie jemals gegessen haben und wir werden Ihnen eventuell sogar beibringen, wie es zubereitet wird.</p> ",
    "body": "<p>Vietnam is one of the world&rsquo;s most exotic and culturally rich destinations. A gem among gems, it offers dazzling diversity for visitors. Yet what most find so fascinating is its capacity for change. This is nowhere more evident than in Ho Chi Minh City. Set on the Saigon river, the capital is the perfect example of progress and tradition living side-by-side. Grand colonial buildings stand alongside modern skyscrapers while Japanese cars share the busy roads with cycle rickshaws.</p>\n<p>We won&rsquo;t just take you to the key sights, but also reveal the hidden stories that explain what makes Vietnam what it is today, and where it&rsquo;s going.</p>\n<p>A two day tour of the Mekong delta (Vietnamese: Đồng bằng S&ocirc;ng Cửu Long &quot;Nine Dragon river delta&quot;) will immerse you in a water-world maze where everything happens on the boats - even local markets which form every day from a raft of vendors boats. We&rsquo;ll continue to the coastal town of Vung Tau in the Phuong district to relax and swim like the locals do.</p>\n<p>While there we&rsquo;ll visit the storied White Palace, the historical old colonial villa of the french governor.</p>\n<p>Along the way, you&rsquo;ll eat some of the finest food you&rsquo;ve ever eaten, and we might even teach you to cook it too.</p> ",
    "description_de": "Entdecken Sie die Kultur und die alltäglichen Schätze eines Phoenix aus der Asche",
    "destination": [
      "7ec72c48-c33f-418e-b2ff-44cfb4bbb1f2"
    ],
    "duration": "14",
    "name_de": "Vielfältiges Vietnam",
    "image": "jcr:1044b3b8-30b1-48fe-8078-832b6cef8fb5",
    "@nodes": []
  }
]

Note that the response above was created with a basic configuration without reference resloving. See lines 9-12 tour-types. You can resolve this referenced nodes within the same REST request if you configure with reference resolving configuration.

Anchor
configuration
configuration
YAML configuration

Multiexcerpt
MultiExcerptNameconfiguration

The delivery endpoint requires a YAML configuration - otherwise it cannot deliver content. Version 2.0 of the magnolia-rest-content-delivery module can have only one configuration. (Future versions will allow multiple configurations which can be distinguished via URL parameter.)

Add the configuration to the folder restEndpoints in a light module or within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module.

Basic configuration

Code Pro
languageyaml
titlemy-lightmodule/restEndpoints /my-endpoint.yaml
class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
  website:
    depth: 3
    includeSystemProperties: false
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    rootPath: /
  dam:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:asset
      - mgnl:folder
    rootPath: /travel-demoe

Properties:

class

required

Must be info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition or a subclass.

implementationClass

required

Must be info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint or a subclass.

params

required

The map defining at least one ore more workspace parameters.

<workspace-name>

required

The name of the JCR workspace to deliver content from. You define as many workspaces as you need.

You define one workspace with the below properties. (The definiton class is

Javadoc resource link
classNameinfo.magnolia.rest.delivery.jcr.WorkspaceParameters
renderTypeasynchronous
).

nodeTypes*

required

An list of allowed node types.

depth*

optional (default=0)

The depth of subnodes to shwo in the result

includeSystemProperties

optional (default=true)

Whether the result should show the system properties.

rootPath

required

The root path of this endpoint. Path information when requesting the endpoint is added to this path.

bypassWorkspaceAcls

optional (default=false)

Note

When set to true JCR - security is bypassed. Use with care and for development reasons only!


limit*

optional (default=10)

The number of nodes (of level 0) in the result. Only used in queryNodes method.

*) These properties can be overridden when calling queryNodes with a request parameter.

Configuring reference resolving

Anchor
reference-resolving-configuration
reference-resolving-configuration
Reference resolving configuration

A node may contain references to other nodes. You can extend the configuration to force it to resolve referenced nodes per workspace with the property references

Code Pro
languageyaml
linenumberstrue
class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
  tours:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:content
      - mgnl:folder
    rootPath: /
    references:
      tour-types:
        propertyName: tourTypes
        referenceResolver:
          implementationClass: info.magnolia.rest.reference.jcr.UuidReferenceResolver
          targetWorkspace: category

Properties of references:

referencesA map which contains at least one reference definition.

<reference-name>

An arbitrary name for a

Javadoc resource link
classNameinfo.magnolia.rest.reference.ReferenceDefinition
renderTypeasynchronous
.

propertyName

The name of the JCR property which stores the reference. (Can be a multi-value property).

referenceResolver

The reference resolver definition for this reference, its definition class is

Javadoc resource link
classNameinfo.magnolia.rest.reference.ReferenceResolverDefinition
renderTypeasynchronous
.

implementationClass

A class implementing

Javadoc resource link
classNameinfo.magnolia.rest.reference.ReferenceResolverDefinition
renderTypeasynchronous
.

Current implementations:

Javadoc resource link
classNameinfo.magnolia.rest.reference.jcr.UuidReferenceResolver
renderTypeasynchronous

targetWorkspace

The name of the workspace where the referenced node resides.


...