#Data Source REST API

#Pengantar

Digunakan untuk mengintegrasikan data dari sumber REST API.

#Instalasi

Plugin ini adalah plugin komersial. Untuk cara aktivasi detail, harap lihat: Panduan Aktivasi Plugin Komersial

#Menambahkan Sumber REST API

Setelah plugin diaktifkan, pilih REST API pada dropdown Add new di manajemen data source.

Konfigurasi sumber REST API

#Menambahkan Collection

Resource RESTful adalah Collection NocoBase, contohnya resource Users

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

Pemetaan ke konfigurasi NocoBase API adalah

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

Spesifikasi desain NocoBase API lengkap dapat dilihat di dokumentasi API

Lihat bagian "NocoBase API - Core"

Konfigurasi Collection data source REST API sebagai berikut

#List

Konfigurasi pemetaan endpoint untuk melihat daftar resource

#Get

Konfigurasi pemetaan endpoint untuk melihat detail resource

#Create

Konfigurasi pemetaan endpoint untuk membuat resource

#Update

Konfigurasi pemetaan endpoint untuk update resource

#Destroy

Konfigurasi pemetaan endpoint untuk menghapus resource

Di antaranya, List dan Get adalah dua endpoint yang wajib dikonfigurasi.

#Debug API

#Mapping Parameter Request

Contoh: Mengonfigurasi parameter pagination untuk endpoint List (jika API pihak ketiga sendiri tidak mendukung pagination, maka pagination dilakukan dengan data daftar yang diambil).

Perhatikan, hanya variabel yang sudah ditambahkan di endpoint yang akan berlaku.

Anda dapat mengklik Try it out untuk debug, dan melihat hasil respons.

#Konversi Format Respons

Format respons API pihak ketiga mungkin tidak sesuai dengan standar NocoBase. Perlu dikonversi sebelum dapat ditampilkan dengan benar di front-end.

Sesuaikan aturan konversi sesuai format respons API pihak ketiga, agar sesuai dengan standar output NocoBase.

Penjelasan alur debug

#Konversi Informasi Exception

Saat API pihak ketiga mengalami exception, format informasi exception yang direspons mungkin tidak sesuai dengan standar NocoBase. Perlu dikonversi sebelum dapat ditampilkan dengan benar di front-end.

Saat konversi informasi exception belum dikonfigurasi, secara default akan dikonversi menjadi informasi exception yang berisi http status code.

Setelah konversi informasi exception dikonfigurasi, agar sesuai dengan standar output NocoBase, front-end dapat menampilkan informasi exception API pihak ketiga dengan benar.

#Variabel

Data Source REST API menyediakan tiga jenis variabel untuk integrasi endpoint

• Variabel Custom Data Source
• Request NocoBase
• Respons Pihak Ketiga

#Variabel Custom Data Source

#Request NocoBase

• Params: Search Params (Query Parameter URL), Params untuk setiap endpoint berbeda;
• Headers: Body request, terutama menyediakan beberapa informasi X- custom NocoBase;
• Body: Body request;
• Token: API token dari request NocoBase saat ini.

#Respons Pihak Ketiga

Saat ini hanya tersedia Body respons

Variabel yang dapat digunakan saat integrasi setiap endpoint sebagai berikut:

#List

#Get

#Create

#Update

#Destroy

#Konfigurasi Field

Dari data endpoint CRUD resource yang diadaptasi, ekstrak metadata field (Fields) sebagai field collection.

Ekstrak metadata field.

Field dan pratinjau.

Edit field (mirip dengan cara di data source lain).

#Menambahkan Block Data Source REST API

Setelah Collection dikonfigurasi, Anda dapat pergi ke antarmuka untuk menambahkan block.