第5章 — 创作内容服务页面

《AEM Headless》教程的第5章介绍了如何通过第4章中定义的模板创建页面。 本章中创建的页面将充当移动设备应用程序的JSON HTTP端点。

注意

已预建/content/wknd-mobile/en/api的页面内容架构。 enapi的基页具有体系结构和组织用途,但并非严格要求。 如果API内容可能会进行本地化,最佳做法是遵循常规的语言副本和多站点管理器页面组织最佳实践,因为API页面可以像任何AEM Sites页面一样进行本地化。

创建事件API页面

  1. 导航到​AEM > Sites > WKND Mobile > English >API
  2. 点按API页面的标签,然后点按顶部操 ​作栏中的创建按钮,并在API页面下创建新的事件API页面。
    1. 点按顶部操作栏中的​创建
    2. 选择​事件API​模板
    3. 在​Name​字段中,输入​events
    4. 在​标题​字段中,输入​事件API
    5. 点按顶部操作栏中的​创建​以创建页面
    6. 点按​完成​以返回AEM Sites管理员

“创作事件API”页面

注意

项目提供了CSS,以便为创作体验提供一些基本样式。

  1. 编辑​事件API​页面,方法是导航到​AEM >站点> WKND移动设备>英语> API,选择​事件API​页面,然后点按顶部操作栏中的​编辑

  2. 通过将​徽标图像​从资产查找器中拖放到图像组件占位符,可添加要在应用程序中显示的徽标图像。

    • 使用/content/dam/wknd-mobile/images/wknd-logo.png中提供的徽标。
  3. 添加​标记行​以在事件上方显示。

    1. 编辑​Text​组件
    2. 输入文本:
      • The WKND is here.
  4. 选择要显示的​事件:

    1. 在​Properties​选项卡中设置以下配置:
      • 模型:事件
      • 父路径:/content/dam/wknd-mobile/en/events
      • 标记:<留空>
    2. 在​Elements​选项卡中设置以下配置:
      • 请移除所有列出的元素,以确保事件内容片段的所有元素都已公开。

查看API页面的JSON输出

通过使用.model.json选择器请求页面,可以查看JSON输出及其格式。

此API的用户必须熟悉此JSON结构(或架构)。 关键的API用户要了解结构的哪些方面是固定的(即, 事件API的徽标(图像)和标记实时(文本),它们是不固定的(即 内容片段列表组件下列出的事件)。

如果在已发布的API上违反此合同,则可能会导致使用的应用程序中的行为不正确。

  1. 在新的浏览器选项卡中,使用.model.json选择器请求事件API页面,该选择器会调用AEM Content Services的JSON导出程序,并将页面和组件序列化为标准化且定义良好的JSON结构。

    这些页面生成的JSON结构是使用应用程序必须与之保持一致的结构。

  2. 请求将​事件API​页面作为​JSON

    结果应类似于:

AEM Content Services JSON输出

注意

使用.tidy选择器,可以以​tidy(格式化)方式输出此JSON,以方便人们阅读:

下一步

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

在此页面上