创建 API 请求 – Headless 设置 accessing-delivering-content-fragments

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

什么是 GraphQL 和 Assets REST API? what-are-the-apis

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

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

启用 GraphQL 端点 enable-graphql-endpoint

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

  1. 导航到​ 工具通用,然后选择 GraphQL

  2. 选择​ 创建

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

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

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

    code language-none
    /content/cq:graphql/<configuration-name>/endpoint
    

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

使用 GraphQL 及 GraphiQL 查询内容

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

GraphiQL 是一个 IDE,包含在您的 AEM 环境中; 在您配置您的端点后,它是可访问/可见的。

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

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

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

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

    GraphiQL 编辑器

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

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

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

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

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

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

后续步骤 next-steps

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

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab