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

#Введение

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

#Установка

Этот плагин является коммерческим, его необходимо загрузить и активировать через менеджер плагинов.

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

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

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

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

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

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

Эти конечные точки API сопоставляются в NocoBase следующим образом:

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

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

Ознакомьтесь с главой «NocoBase API - Core» для получения подробной информации.

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

#List

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

#Get

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

#Create

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

#Update

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

#Destroy

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

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

#Отладка API

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

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

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

Вы можете нажать «Попробовать» (Try it out), чтобы отладить и просмотреть ответ.

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

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

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

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

#Переменные

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

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

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

#Запрос NocoBase

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

#Ответы сторонних сервисов

В настоящее время доступно только тело ответа.

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

#List

#Get

#Create

#Update

#Destroy

#Настройка полей

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

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

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

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

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

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