Drupal 10 JSON API 使用指南：标准化数据交换与高效开发

一. JSON API 简介

JSON API 是一种用于以 JSON 格式构建 API 的标准化规范，它通过提供清晰、一致的数据交换结构，简化了 API 的创建和使用过程。

在 Drupal 中，JSON API 是访问数据结构（如实体类型、捆绑包、字段等）的核心模块。它支持构建解耦应用程序，或将 Drupal 与其他系统集成，提升开发效率和系统可扩展性。

二. 启用 JSON API

要启用 Drupal JSON API：

访问 /admin/config/services/jsonapi 页面。
勾选“接受所有 JSON API 创建、读取、更新和删除操作”选项，以允许 POST、PATCH 和 DELETE 操作。

三. JSON API 基础概念

在 JSON API 中，每个资源都必须具有全局唯一的 type 属性。在 Drupal 的 JSON API 实现中，该属性由实体类型的机器名称和捆绑包的机器名称派生。例如：

文章类型资源：node--article
页面类型资源：node--page
用户类型资源：user--user

四. JSON API URL 结构示例

以下是 JSON API 支持的 HTTP 方法及 URL 结构示例：

GET | POST：/jsonapi/node/article
PATCH | DELETE：/jsonapi/node/article/{uuid}

1. GET 请求

用于检索资源集合或单个资源，需包含请求头：

Accept: application/vnd.api+json

响应

HTTP 200：返回单个节点的 JSON API 对象，包括属性、关系和链接。

2. POST 请求

用于创建资源，需包含请求头：

Accept: application/vnd.api+json

同时，可通过 /session/token 获取访问令牌。

示例

URL: http://example.com/jsonapi/node/article

响应

HTTP 201（已创建）：返回创建实体的 JSON API 对象。

3. DELETE 请求

所有 DELETE 请求需包含请求头：

Content-Type: application/vnd.api+json

示例

响应

HTTP 204（无内容）：响应体为空。

4. PATCH 请求

用于更新资源，请求头需包含：

Accept: application/vnd.api+json

Authorization: Basic <token>

响应

HTTP 200：返回更新后的实体的 JSON API 对象。

五. JSON API 的特性

1. 自动序列化

JSON API 自动处理数据序列化，将 Drupal 数据转换为标准 JSON API 格式，减少自定义序列化开发工作。

2. 分页和排序

内置分页和排序功能，帮助客户端高效处理大型数据集。

3. 关系支持

允许在单个请求中获取相关资源，减少多次 API 调用次数。

4. 过滤和查询

通过 URL 查询参数对资源进行过滤，只请求所需数据，提升性能。

六. Drupal 10 使用 JSON API 的优势

1. 简化开发

提供标准化接口，显著降低开发复杂性。

2. 提高效率

自动序列化和关系支持降低数据处理难度，加快开发进程。

3. 广泛兼容

多语言、多框架支持，使 Drupal 可轻松与其他系统集成。

4. 可扩展性

RESTful 设计使网站能轻松扩展，应对更多客户端和请求。

七. 结论

Drupal JSON API 是强大且标准化的工具，能够以灵活方式公开内容，简化解耦应用开发和第三方集成。使用 JSON API 可显著提升开发效率、系统可扩展性，并符合最佳实践标准。

原文链接

Introduction of Drupal JSONAPI | ToTheNew