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

#Введение

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

#Установка

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

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

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

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

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

RESTful-ресурс является коллекцией 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».

Настройка коллекции источника данных 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: заголовки запроса, главным образом содержащие пользовательские X-параметры NocoBase;
• Body: тело запроса;
• Token: API-токен текущего запроса NocoBase.

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

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

При подключении каждого интерфейса доступны следующие переменные:

#List

#Get

#Create

#Update

#Destroy

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

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

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

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

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

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

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