#Источник данных REST API

#Введение

Этот плагин позволяет бесшовно интегрировать данные из источников REST API.

#Установка

Это коммерческий плагин. Подробные инструкции по активации см. в руководстве: Commercial Plugin Activation Guide

#Добавление источника REST API

После активации плагина источник REST API можно добавить, выбрав его в выпадающем меню "Добавить" в разделе управления источниками данных.

Настройте источник REST API.

#Добавление коллекции

В NocoBase RESTful-ресурс сопоставляется с коллекцией, например ресурс Users.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

Эти API-endpoints сопоставляются в NocoBase следующим образом:

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

Подробные правила проектирования API в NocoBase см. в документации API.

Подробности см. в главе "NocoBase API - Core".

Конфигурация коллекции для источника данных REST API включает следующее:

#Список (List)

Сопоставляет интерфейс просмотра списка ресурсов.

#Получение (Get)

Сопоставляет интерфейс просмотра деталей ресурса.

#Создание (Create)

Сопоставляет интерфейс создания ресурса.

#Обновление (Update)

Сопоставляет интерфейс обновления ресурса.

#Удаление (Destroy)

Сопоставляет интерфейс удаления ресурса.

Интерфейсы List и Get обязательны к настройке.

#Отладка API

#Интеграция параметров запроса

Пример: настройка параметров пагинации для List API. Если сторонний API не поддерживает пагинацию нативно, NocoBase выполнит пагинацию на основе полученных данных списка.

Обратите внимание: применяются только переменные, добавленные в интерфейсе.

Можно нажать "Попробовать", чтобы выполнить отладку и посмотреть ответ.

#Преобразование формата ответа

Формат ответа стороннего API может не соответствовать стандарту NocoBase, поэтому перед корректным отображением на фронтенде его нужно преобразовать.

Скорректируйте правила преобразования с учетом формата ответа стороннего API, чтобы выход соответствовал стандарту NocoBase.

Описание процесса отладки

#Извлечение сообщения об ошибке

Когда сторонний API возвращает исключение, формат ответа может не соответствовать стандарту NocoBase. В таких случаях сообщение об ошибке нужно преобразовать для корректного отображения на фронтенде.

Если преобразователь сообщения об ошибке не настроен, NocoBase применит преобразование по умолчанию и преобразует ошибку в сообщение с HTTP-кодом статуса.

После настройки преобразователя сообщения об ошибке в соответствии со стандартом вывода NocoBase фронтенд сможет корректно отображать сообщения об исключениях, возвращаемые сторонним API.

#Переменные

Источник данных REST API поддерживает три типа переменных для интеграции API:

• Пользовательские переменные источника данных
• Переменные запроса NocoBase
• Переменные ответа стороннего API

#Пользовательские переменные источника данных

#Запрос NocoBase

• Параметры: параметры URL-запроса (Search Params), зависящие от интерфейса.
• Заголовки: пользовательские заголовки запроса, в основном передающие специфичную X- информацию от NocoBase.
• Тело: тело запроса.
• Токен: API-токен текущего запроса NocoBase.

#Ответы стороннего API

Сейчас доступно только тело ответа.

Ниже переменные, доступные для каждого интерфейса:

#Список (List)

#Получение (Get)

#Создание (Create)

#Обновление (Update)

#Удаление (Destroy)

#Конфигурация полей

Метаданные полей извлекаются из данных CRUD-интерфейсов адаптированного ресурса и используются как поля коллекции.

Извлечение метаданных поля.

Поля и предварительный просмотр.

Редактирование полей (аналогично другим источникам данных).

#Добавление блоков источника данных REST API

После настройки коллекции можно добавить блоки в интерфейс.