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

#Введение

Используется для подключения данных из источника REST API.

#Установка

Этот плагин является коммерческим. Подробные сведения об активации см. в разделе Руководство по активации коммерческих плагинов

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

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

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

#Добавление Collection

Ресурсы RESTful — это Collection в NocoBase, например ресурс 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

Полную спецификацию API NocoBase см. в документации API.

См. раздел «NocoBase API — Core».

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

#List

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

#Get

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

#Create

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

#Update

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

#Destroy

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

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

#Отладка API

#Сопоставление параметров запроса

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

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

Для отладки и просмотра результата ответа можно нажать Try it out.

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

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

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

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

#Преобразование сведений об ошибках

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

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

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

#Переменные

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

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

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

#Запрос NocoBase

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

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

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

Доступные переменные для разных интерфейсов:

#List

#Get

#Create

#Update

#Destroy

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

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

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

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

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

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

После настройки Collection можно перейти к добавлению блока в интерфейсе.