设置和将AEM GraphQL与内容片段一起使用的最佳实践

上次更新: 2023-11-18

这些准则汇总了将AEM与GraphQL和内容片段设置、配置和使用的推荐最佳实践。

快速入门

为了帮助您快速掌握:

设置

要安全设置AEM GraphQL以与内容片段和您的应用程序一起使用,您需要配置各种组件。

GraphQL端点创建(包括安全性)

端点是 AEM 用于访问 GraphQL 的路径。需要创建和发布这些端点,以便可以安全地访问它们。

详细信息

在 AEM 中管理 GraphQL 端点

环境

端点需要配置于:

  • 创作
  • 预览
  • 发布

对于:

  • 开发
  • 测试
  • 生产

AEM Dispatcher缓存

注意

如果启用了Dispatcher中的缓存,则 CORS设置 不需要使用,因此可以忽略。

默认情况下,Dispatcher 中未启用持久化查询的缓存。无法实施默认启用,因为对多个源使用 CORS(跨源资源共享)的客户需要检查并(可能需要)更新其 Dispatcher 配置。

详细信息

GraphQL 持久化查询 - 在 Dispatcher 中启用缓存

环境

Dispatcher通常配置为执行以下操作:

  • 发布:生产

CORS设置

注意

如果缓存 AEM调度程序 启用,则无需进行CORS设置,因此可以忽略此部分。

要访问 GraphQL 端点,必须配置 CORS 策略并添加到通过 Cloud Manager 部署到 AEM 的 AEM 项目。此操作可通过为所需端点添加相应的 OSGi CORS 配置文件来完成。

详细信息

跨源资源共享 (CORS) 配置

环境

CORS通常配置为用于:

  • 发布:生产

身份验证

用于内容片段投放的 Adobe Experience Manager as a Cloud Service (AEM) GraphQL API 的主要用例是接受来自第三方应用程序或服务的远程查询。这些远程查询可能需要经过身份验证的 API 访问,以保护 Headless 内容投放。

详细信息

对内容片段的远程 AEM GraphQL 查询的身份验证

环境

身份验证通常配置为执行以下操作:

  • 预览
  • 发布

对于:

  • 开发
  • 测试
  • 生产

权限

使用 Headless 实施,需要解决多个不同的安全和权限领域。根据 AEM 环境​创作​或​发布,可以广泛地考虑权限和角色。每个环境包含不同的角色并有不同的需求。

详细信息

Headless 内容的权限注意事项

环境

权限通常配置为用于:

  • 创作
  • 预览
  • 发布

对于:

  • 开发
  • 测试
  • 生产

使用内容交付网络(CDN)

如果定位为,则可以缓存GraphQL查询及其JSON响应。 GET 使用CDN时的请求。 相比之下,未缓存的请求可能非常(资源)昂贵且处理缓慢,有可能对源头资源造成进一步的有害影响。

详细信息

AEM as a Cloud Service 中的 CDN

环境

CDN通常配置为执行以下操作:

  • 发布:生产

配置和创建内容片段

AEM GraphQL用于从您的内容片段中检索信息。 需要配置这些内容,然后定义结构和位置,然后才能创建内容。

详细信息

环境

在以下位置定义、创作、测试、发布和访问内容片段:

  • 创作
  • 预览
  • 发布

对于:

  • 开发
  • 测试
  • 生产

使用AEM GraphQL

优化GraphQL查询

提供这些准则是为了帮助防止GraphQL查询出现性能问题。

详细信息

优化 GraphQL 查询

注意

优化指南涵盖缓存配置,已包含在 设置.

从您的应用程序访问GraphQL

AEM Headless CMS使开发人员能够自由地使用他们已熟悉的语言、框架和工具构建和提供卓越的体验。

详细信息

环境

应用程序通常在以下环境中开发、测试和使用:

  • 预览
  • 发布

对于:

  • 开发
  • 测试
  • 生产

其他资源

有关AEM GraphQL和内容片段的更多详细信息,请参阅以下内容:

在此页面上