第4章 — 定义Content Service模板

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

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

AEM可编辑模板用于定义访问的HTTP端点,以将事件内容公开为JSON。

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

在AEM Content Services中,可编辑模板用于定义如何公开JSON数据。

对于 WKND Mobile 应用程序上,我们将创建一个可编辑的模板,用于驱动单个API端点。 虽然此示例非常简单以说明AEM Headless的概念,但您可以创建多个页面(或端点),每个页面或端点都会公开不同的内容集,以便创建更复杂、更有条理的API。

了解API端点

了解如何构建API端点,以及应向我们的网站展示哪些内容 WKND Mobile 应用程序,让我们重新访问设计。

事件API页面分解

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

  1. 徽标
  2. 标记行
  3. 列表 活动

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

  1. 徽标 是通过 图像组件
  2. 标记行 是通过 文本组件
  3. 列表 活动 是通过 内容片段列表组件 这进而会引用一组事件内容片段。
NOTE
要支持AEM Content Service的页面和组件的JSON导出,页面和组件必须 从AEM WCM核心组件派生.
AEM WCM核心组件 具有内置功能,可支持导出的页面和组件的标准化JSON架构。 本教程中使用的所有WKND Mobile组件(页面、图像、文本和内容片段列表)均派生自AEM WCM核心组件。

定义事件API模板

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

  2. 创建 Events API 模板:

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

  4. 属性 > 允许的组件 搜索 WKND Mobile. 允许以下组件来自 WKND Mobile 组件组,以便它们可用于 Events API页面。

    • WKND Mobile > Image

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

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

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

  6. 刷新 要查看的浏览器窗口 允许的组件 左侧边栏中的列表。

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

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

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

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

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

后续步骤

(可选)安装 com.adobe.aem.guides.wknd-mobile.content.chapter-4.zip AEM创作中的内容包,通过 AEM包管理器. 此资源包包含本教程及前面章节中概述的配置及内容。

recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4