Drupal привел к значительным архитектурным изменениям, предлагая современные методы создания цифрового опыта. REST API был одним из них, и он поставлялся в ядре. RESTful API — это API, который соответствует архитектурному стилю REST. Он получает доступ и использует данные через HTTP-запросы к типам данных GET, PUT, POST и DELETE.
HTTP-методы используемые в REST API
GET: этот метод используется для чтения данных с сервера.
POST: этот метод используется для создания данных на сервере.
PATCH: этот метод используется для обновления данных на сервере.
DELETE: этот метод используется для удаления данных с сервера.
Первоначально клиент отправляет запрос с использованием методов HTTP. REST API взаимодействует с базой данных и отправляет ответ в форматах JSON или XML.
Drupal позволяет разработчикам легко создавать API-интерфейсы, позволяющие предоставлять контент другим программам без написания кода.
Модули Drupal для вашего API
Ниже перечислены модули, которые могут помочь в создании вашего API в Drupal.
HAL
Модуль HAL специально предназначен для JSON или XML и предоставляет плагин сериализации.
HTTP Basic Authentication
Модуль базовой аутентификации HTTP предоставляет плагин аутентификации, который позволяет нам контролировать доступ к нашим ресурсам API на основе метода HTTP.
RESTful Web Services
Модуль веб-служб RESTful управляет системой подключаемых модулей ресурсов, а также определяет начальные маршруты ресурсов. Хороший пример подключаемого модуля ресурсов можно найти в модуле журнала БД, который предоставляет конечную точку API для записей сторожевого таймера.
Плагин отвечает за получение данных из базы данных.
Serialization
Модуль сериализации отвечает за десериализацию и сериализацию данных ответа на запрос.
REST UI
Пользовательский интерфейс Rest — полезный модуль, который предоставляет доступ к конфигурации наших веб-служб RESTful через пользовательский интерфейс администратора. Таким образом, мы можем настроить конечные точки нашего API, отредактировав файлы YML.
Как работает REST
Сначала клиент отправляет запрос, данный запрос отправляется обработчику запросов. Request Handler отвечает за прием запроса.
Обработчик запросов взаимодействует с модулем REST и отвечает на запросы. Затем запросы отправляются на десериализацию для нормализации данных.
Затем десериализация отправляет обработчику запроса. Обработчик запроса сопоставляет ресурс с соответствующим обработчиком ресурсов.
Опять же, запрос отправляется подключаемому Resource Plugin. Он берет данные из входящего запроса и извлекает действительную информацию из базы данных.
Затем подключаемый Resource Plugin возвращает данные обработчику запросов и снова работает с сериализатором перед отправкой в качестве ответа.
Как настроить REST API в Drupal с помощью модулей
3 простых этапа для настройки REST API в Drupal с использованием основных модулей:
Этап 1. Первоначально вам необходимо установить основные модули: HAl, Http Basic Authentication, REST Web Services и модуль Serialization. Далее вам необходимо загрузить модуль REST UI и включить его.
Этап 2. Затем вам необходимо настроить конечные точки REST API в соответствии с требованиями. Чтобы настроить, перейдите в Конфигурация -> REST -> затем нажмите на редактирование.
Этап 3. Когда вы нажмете на редактирование, вы увидите окно редактирования. Настройте как требуется, затем сохраните конфигурацию.