创建 API 请求 - Headless 设置

了解如何使用 GraphQL API 实现内容片段的 Headless 投放,以及如何使用 AEM 的 Assets REST API 管理内容片段。

注意

该功能的部分功能在预发布渠道中提供。特别是与持久查询相关的功能。

有关如何为您的环境启用该功能的信息,请参阅预发布渠道文档

什么是 GraphQL 和 Assets REST API?

现在您已经创建了一些内容片段,您可以使用 AEM 的 API 以 Headless 的方式交付它们。

本指南的剩余部分侧重于 GraphQL 访问和内容片段投放。

启用 GraphQL 端点

必须先创建 GraphQL 端点,然后才能使用 GraphQL API。

  1. 导航到 工具, 常规,然后选择 GraphQL.

  2. 选择​创建

  3. 此时将打开​创建新 GraphQL 端点​对话框。在其中可以指定:

    • 名称:端点的名称,您可以输入任意文本。
    • 使用的 GraphQL 架构提供自:使用下拉菜单选择所需的配置。
  4. 选择​创建​来确认。

  5. 在控制台中,此时将根据之前创建的配置显示一条​路径。这是用于执行 GraphQL 查询的路径。

    /content/cq:graphql/<configuration-name>/endpoint
    

有关启用 GraphQL 端点的更多详细信息见此处

使用 GraphQL 及 GraphiQL 查询内容

信息架构师需要为其渠道端点设计查询来交付内容。这些查询通常只需要为每个模型的每个端点考虑一次。对于本指南快速入门,我们只需要创建一个。

GraphiQL 是可以安装在 AEM 环境中的 IDE。按照使用 GraphiQL IDE 中的步骤操作来安装 AEM 环境。

  1. 登录 AEM as a Cloud Service 并访问 GraphiQL 接口:

    您可以通过以下任一方式访问查询编辑器:

    • 工具 -> 常规 -> GraphQL查询编辑器
    • 直接;例如, http://localhost:4502/aem/graphiql.html
  2. GraphiQL IDE 是用于 GraphQL 的浏览器中查询编辑器。您可以使用它来生成查询,以检索内容片段,并将通过 JSON 格式无头交付。

    • 右上角的下拉列表允许您选择端点。
    • 最左边的面板列出了持久查询(如果可用)
    • 左中面板允许您生成查询。
    • 右中面板显示结果。
    • 查询编辑器具备代码完成和热键功能,可以轻松地执行查询。

    GraphiQL 编辑器

  3. 假定我们创建的模型名为 person,带有字段 firstNamelastNameposition,我们可以构建简单的查询来检索内容片段的内容。

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. 在左侧面板中输入查询。
    GraphiQL 查询

  5. 单击​执行查询​按钮或者使用 Ctrl-Enter 热键,结果将在右侧面板中以 JSON 格式显示。
    GraphiQL 结果

  6. 单击页面右侧的​文档​链接以显示上下文中的文档,帮助您构建适应您自己的模型的查询。
    GraphiQL 文档

GraphQL 启用结构化查询,不仅针对特定数据集或者单独的数据对象,而且还可以提供对象的特定元素,嵌套结果,提供查询变量支持,以及诸多功能。

GraphQL 可以避免迭代 API 以及过度投放,而是允许作为对单个 API 查询的响应,批量精确投放所需呈现的内容。生成的 JSON 可用于向其他站点或应用程序提供数据。

后续步骤

就是这样!现在,您已对 AEM 中的 Headless 内容管理有了基本了解。当然,其中还有很多资源供您深入研究,以全面了解可用的功能。

在此页面上