第4章 — 定义内容服务模板

AEM Headless教程的第4章介绍了AEM可编辑模板在AEM内容服务上下文中的角色。 可编辑的模板用于定义AEM Content Services通过组合启用了Content Services的AEM组件而向客户公开的JSON内容结构。

了解模板在AEM Content Services中的角色

AEM可编辑的模板用于定义将用来将事件内容显示为JSON的HTTP端点。

传统上,AEM可编辑的模板用于定义网页,但这种用法只是惯例。 可编辑的模板可用于撰写​任何​内容集;如何访问该内容:作为浏览器中的HTML,JavaScript(AEM SPA Editor)或移动设备应用程序使用的JSON取决于该页面的请求方式。

在AEM Content Services中,可编辑的模板用于定义JSON数据的显示方式。

对于WKND Mobile应用程序,我们将创建一个可编辑的模板,该模板将用于驱动单个API端点。 尽管此示例简单地说明了AEM Headless的概念,但您可以创建多个页面(或端点),每个页面都公开不同的内容集,以创建更复杂、组织更好的API。

了解API端点

要了解如何编写API端点,并了解应将哪些内容显示到我们的WKND Mobile应用程序,请让我们重新访问设计。

事件API页面分解

如我们所见,我们有三组逻辑内容要提供给移动设备应用程序。

  1. Logo
  2. 标记行
  3. Events​的列表

为此,我们可以将这些要求映射到AEM组件(在本例中为AEM WCM核心组件),以便将必需的内容显示为JSON。

  1. 将通过​图像组件​显示​Logo
  2. 将通过​文本组件​显示​标签行
  3. 事件​的列表将通过​内容片段列表组件​显示,该组件又引用一组事件内容片段。
注意

要支持AEM内容服务对页面和组件进行JSON导出,页面和组件必须​从AEM WCM核心组件​派生。

AEM WCM核心组 件提供了内置功能,可支持导出的页面和组件的标准化JSON模式。本教程中使用的所有WKND移动设备组件(页面、图像、文本和内容片段列表)均源自AEM WCM核心组件。

定义事件API模板

  1. 导航到​工具 > 常规 > 模板 >WKND Mobile

  2. 创建​Events API​模板:

    1. 点按顶部操作栏中的​创建
    2. 选择​WKND Mobile - Empty Page​模板
    3. 点按顶部操作栏中的​Next
    4. 在模板标题字段中输入​Events API
    5. 点按顶部操作栏中的​创建
    6. 点按​打开​打开新模板进行编辑
  3. 首先,我们允许三个已识别的AEM组件,通过编辑根布局容器的Policy来对内容进行建模。 确保​结构​模式处于活动状态,选择​Layout Container [Root],然后点按​Policy​按钮。

  4. 在​属性 > 允许的组件​下,搜索​WKND Mobile。 允许WKND Mobile组件组中的以下组件,以便在Events API页面上使用。

    • WKND Mobile > Image

      • 应用程序的徽标
    • WKND Mobile > Text

      • 应用程序的介绍性文本
    • WKND Mobile > Content Fragment List

      • 可在应用程序中显示的事件类别列表
  5. 完成后,点按右上角的​Done​复选标记。

  6. ​刷新浏览器窗口,以在左边 栏 中查看新允许的组件列表。

  7. 从左边栏的组件查找器中,拖入以下AEM组件:

    1. Image 标识
    2. Text 标记行
    3. Content Fragment List 对于事件
  8. 对于上述每个组件,选择它们并按“解锁” ​按钮。

  9. 但是,请确保​布局容器​为​锁定的,以防止添加其他组件,或者删除这三个组件。

  10. 点按​页面信息 > 在管理员​中查看,以返回到WKND Mobile模板列表。 选择新创建的​Events API​模板,然后点按顶部操作栏中的​启用

注意

请注意,用于显示内容的组件会添加到模板本身并被锁定。 这是为了允许作者编辑预定义的组件,但不能任意添加或删除组件,因为更改API本身可能会破坏JSON结构的假设并破坏耗费的应用程序。 所有API都需要稳定。

下面的步骤

或者,也可以选择通过AEM Package Manager在AEM作者上安装com.adobe.aem.guides.wknd-mobile.content.chapter-4.zip内容包。 此包包含教程本章及前几章中概述的配置和内容。

在此页面上