#Sumber Data REST API

#Pengenalan

Digunakan untuk menghubungkan data dari sumber REST API.

#Instalasi

Plugin ini merupakan plugin komersial. Untuk metode aktivasi selengkapnya, lihat：Panduan Aktivasi Plugin Komersial

#Menambahkan Sumber REST API

Setelah plugin diaktifkan, pilih REST API dari menu tarik-turun Add new di Manajemen sumber data.

Mengonfigurasi Sumber REST API

#Menambahkan Collection

Resource RESTful merupakan Collection di NocoBase, misalnya resource Users.

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

Konfigurasinya dalam API NocoBase adalah

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

Untuk spesifikasi desain API NocoBase selengkapnya, lihat dokumentasi API

Lihat bab 「NocoBase API - Core」

Konfigurasi Collection sumber data REST API adalah sebagai berikut

#List

Konfigurasikan pemetaan antarmuka untuk melihat daftar resource

#Get

Konfigurasikan pemetaan antarmuka untuk melihat detail resource

#Create

Konfigurasikan pemetaan antarmuka untuk membuat resource

#Update

Konfigurasikan pemetaan antarmuka untuk memperbarui resource

#Destroy

Konfigurasikan pemetaan antarmuka untuk menghapus resource

List dan Get adalah dua antarmuka yang wajib dikonfigurasi.

#Menguji API

#Menghubungkan Parameter Permintaan

Contoh: mengonfigurasi parameter pagination untuk antarmuka List (jika API pihak ketiga itu sendiri tidak mendukung pagination, pagination dilakukan berdasarkan data daftar yang diperoleh).

Perhatikan bahwa hanya variabel yang telah ditambahkan dalam antarmuka yang akan berlaku.

Klik Try it out untuk melakukan pengujian dan melihat hasil respons.

#Konversi Format Respons

Format respons API pihak ketiga mungkin tidak sesuai dengan standar NocoBase dan perlu dikonversi agar dapat ditampilkan dengan benar di frontend.

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

Penjelasan alur pengujian

#Konversi Informasi Kesalahan

Jika terjadi kesalahan pada API pihak ketiga, format informasi kesalahan dalam respons mungkin tidak sesuai dengan standar NocoBase dan perlu dikonversi agar dapat ditampilkan dengan benar di frontend.

Jika konversi informasi kesalahan belum dikonfigurasi, informasi tersebut secara default dikonversi menjadi informasi kesalahan yang mencakup kode status http.

Setelah konversi informasi kesalahan dikonfigurasi agar sesuai dengan standar output NocoBase, frontend dapat menampilkan informasi kesalahan dari API pihak ketiga dengan benar.

#Variabel

Sumber data REST API menyediakan tiga jenis variabel untuk integrasi antarmuka

• Variabel Kustom Sumber Data
• Permintaan NocoBase
• Respons Pihak Ketiga

#Variabel Kustom Sumber Data

#Permintaan NocoBase

• Params: parameter kueri URL (Search Params), Params setiap antarmuka dapat berbeda;
• Headers: badan permintaan, terutama menyediakan beberapa informasi X- kustom NocoBase;
• Body: Body permintaan;
• Token: API token dari permintaan NocoBase saat ini.

#Respons Pihak Ketiga

Saat ini yang tersedia hanya Body respons

Variabel yang tersedia saat mengintegrasikan setiap antarmuka adalah sebagai berikut:

#List

#Get

#Create

#Update

#Destroy

#Mengonfigurasi Field

Ekstrak metadata field (Fields) dari data antarmuka CRUD resource yang diadaptasi untuk dijadikan field Collection.

Ekstrak metadata field.

Field dan pratinjau.

Edit field (caranya mirip dengan sumber data lainnya).

#Menambahkan Blok Sumber Data REST API

Setelah Collection selesai dikonfigurasi, Anda dapat menambahkan blok melalui antarmuka.