JSON:API 通往 Drupal 8 的发展之路 | Opensense Labs

作为一种编码方案，JSON（JavaScript 对象表示法）旨在简化客户端与服务器之间的通信，减少对特殊代码的依赖，从而提升请求处理的效率。在本文中，我们将探讨 JSON:API 在 Drupal 8 中的发展历程，以及它如何为开发者提供更高效的解决方案。

Drupal 8 与 JSON:API 的发展历程

2015 年，Drupal 8 推出了 REST API，这是迈向 API 优先（API-first）Drupal 未来的第一步。随着时间推移，后续版本对其进行了不断改进，由此催生了 API-first Drupal 生态系统中的多个重要项目模块，例如：

• GraphQL
• Simple OAuth
• Open API
• Consumers
• RELAXed Web Services
• Subrequest

其中，JSON:API 模块作为贡献模块最终被纳入了 Drupal 核心。经过 28 个月的开发、450 次提交、32 次发布和超过 5500 次测试运行，JSON:API 模块正式在 Drupal 8.7 分支中发布。

重要提示：根据 Wim Leers 的说法，使用 Drupal 8.5 或 8.6 上 JSON:API 8.x-2.x 贡献模块的用户可以无缝升级至 Drupal 8.7，同时贡献模块将停止支持。

JSON:API 模块的工作原理

JSON:API 模块通过网络服务 API 提供对 Drupal 实体（如博客文章、用户、评论等）的访问，极大地提升了内容创作体验。它通过 HTTP 方法生成访问实体类型和捆绑包的 URL，使开发者能够：

• 获取特定实体字段（例如，仅提取博客标题）。

这种模块化的设计使得 JSON:API 成为开发者在构建高效数据接口时的理想选择。

JSON:API 与 REST 的对比

尽管 Drupal 核心提供了 REST 模块，允许高度的可配置性，但 JSON:API 专注于展示 Drupal 的数据建模能力，简化了开发流程。相比之下，REST 模块的复杂性和脆弱性可能会给开发者带来额外的负担。

JSON:API 的功能强大且易于使用，能够保持开发流程的清晰性。这也是为什么像 Google、Twitter 和 Facebook 这样的互联网巨头选择 JSON 作为数据交换格式的原因——它自描述性强、易于理解且简单高效。

JSON:API 的最佳实践

Drupal 的 JSON:API 模块及其实现具有以下显著优势：

• 开箱即用支持 1.0 规范。
• 借助 Drupal 强大的实体 API、字段 API 和访问控制 API，开发者可以通过 Web 服务 API 高效地获取数据。

JSON:API 相关模块

以下是一些与 JSON:API 配合使用的模块，它们为开发者提供了更多功能和灵活性：

1. Key Authentication 模块
   提供简单的基于密钥的身份验证，适用于公开面向消费者的 API 网站，无需额外配置。

2. Lightning API
   使用 Drupal 的标准数据库更新系统，通过 JSON:API 和 Simple OAuth 模块，支持 OAuth2 标准，提供带身份验证和授权的标准 API。

3. JSON:API Extras
   允许开发者自定义由 JSON:API 模块生成的 API。通过此模块，可以覆盖默认实现，启用或禁用资源，增强字段输出，并修改资源路径和名称。

JSON:API 的安全注意事项

尽管 JSON:API 能快速修复 Drupal.org 上稳定模块的安全漏洞，但对于自定义模块或非稳定贡献模块，开发者需自行承担风险。以下是一些安全建议：

• 限制功能：JSON:API 无法执行某些“CRUD”操作，例如注册新账户、登录或请求新密码。这些功能并非 JSON:API 的设计目标。

结论

随着基于 Web 的 API 的快速发展，JSON 已成为比 XML 更高效的数据交换格式。JSON:API 的引入为 Drupal 生态系统注入了新的活力，极大地提升了开发效率。未来，我们期待 JSON:API 在更多场景中的应用和发展。

原文链接

通过 [email protected] 与我们分享您的想法。

原文链接: https://opensenselabs.com/blog/road-jsonapi-drupal-8