#Sumber Data REST API

#Pengenalan

Digunakan untuk menghubungkan data dari sumber REST API.

#Penginstalan

Plugin ini merupakan plugin komersial. Untuk mengetahui cara aktivasinya secara lengkap, silakan lihat: Panduan Aktivasi Plugin Komersial

#Menambahkan Sumber REST API

Setelah plugin diaktifkan, pilih REST API dari menu dropdown Add new di pengelolaan 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

Konfigurasi pemetaannya di NocoBase API adalah

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

Untuk spesifikasi lengkap desain NocoBase API, lihat dokumentasi API

Lihat bab 「NocoBase API - Core」

Konfigurasi Collection sumber data REST API adalah sebagai berikut

#List

Konfigurasikan pemetaan endpoint untuk melihat daftar resource

#Get

Konfigurasikan pemetaan endpoint untuk melihat detail resource

#Create

Konfigurasikan pemetaan endpoint untuk membuat resource

#Update

Konfigurasikan pemetaan endpoint untuk memperbarui resource

#Destroy

Konfigurasikan pemetaan endpoint untuk menghapus resource

List dan Get adalah dua endpoint yang wajib dikonfigurasi.

#Menguji API

#Menghubungkan parameter permintaan

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

Perhatikan bahwa hanya variabel yang telah ditambahkan di dalam endpoint 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. Konversi perlu dilakukan 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. Konversi perlu dilakukan agar dapat ditampilkan dengan benar di frontend.

Jika konversi informasi kesalahan belum dikonfigurasi, secara default informasi tersebut akan dikonversi menjadi informasi kesalahan yang menyertakan 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 menghubungkan endpoint

• Variabel kustom sumber data
• Permintaan NocoBase
• Respons pihak ketiga

#Variabel kustom sumber data

#Permintaan NocoBase

• Params: parameter kueri URL (Search Params); Params setiap endpoint dapat berbeda;
• Headers: header 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 menghubungkan setiap endpoint adalah sebagai berikut:

#List

#Get

#Create

#Update

#Destroy

#Mengonfigurasi kolom

Ekstrak metadata kolom (Fields) dari data endpoint CRUD resource yang diadaptasi untuk digunakan sebagai kolom dalam collection.

Ekstrak metadata kolom.

Kolom dan pratinjau.

Edit kolom (caranya mirip dengan sumber data lainnya).

#Menambahkan blok sumber data REST API

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