#Джерело даних REST API

#Вступ

Цей плагін дозволяє легко інтегрувати дані з джерел REST API.

#Встановлення

Цей плагін є комерційним, тому його потрібно завантажити та активувати через менеджер плагінів.

#Додавання джерела REST API

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

Налаштуйте джерело REST API.

#Додавання колекції

У NocoBase RESTful-ресурс відображається як колекція, наприклад, ресурс "Користувачі".

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 включає наступне:

#Список

Налаштуйте відображення інтерфейсу для перегляду списку ресурсів.

#Отримати

Налаштуйте відображення інтерфейсу для перегляду деталей ресурсу.

#Створити

Налаштуйте відображення інтерфейсу для створення ресурсу.

#Оновити

Налаштуйте відображення інтерфейсу для оновлення ресурсу.

#Видалити

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

Інтерфейси "Список" та "Отримати" є обов'язковими для налаштування.

#Відлагодження API

#Інтеграція параметрів запиту

Приклад: Налаштуйте параметри пагінації для API "Список". Якщо сторонній 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.

#Відповіді сторонніх сервісів

Наразі доступне лише тіло відповіді.

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

#Список

#Отримати

#Створити

#Оновити

#Видалити

#Налаштування полів

Метадані полів (Fields) витягуються з даних CRUD-інтерфейсу адаптованого ресурсу, щоб слугувати полями колекції.

Витяг метаданих полів.

Поля та попередній перегляд.

Редагування полів (аналогічно іншим джерелам даних).

#Додавання блоків джерела даних REST API

Після налаштування колекції ви можете додавати блоки до інтерфейсу.