#Sumber Data REST API

#Pendahuluan

Plugin ini memungkinkan Anda untuk mengintegrasikan data dari sumber REST API dengan mudah.

#Instalasi

Sebagai plugin komersial, Anda perlu mengunggah dan mengaktifkan plugin ini melalui manajer plugin.

#Menambahkan Sumber Data REST API

Setelah mengaktifkan plugin, Anda dapat menambahkan sumber data REST API dengan memilihnya dari menu dropdown "Add new" di bagian manajemen sumber data.

Konfigurasikan sumber data REST API.

#Menambahkan koleksi

Di NocoBase, sebuah sumber daya RESTful dipetakan ke sebuah koleksi, seperti sumber daya Pengguna (Users).

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

Endpoint API ini dipetakan di NocoBase sebagai berikut:

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

Untuk panduan lengkap mengenai spesifikasi desain API NocoBase, silakan merujuk ke dokumentasi API.

Periksa bab "NocoBase API - Core" untuk informasi lebih lanjut.

Konfigurasi koleksi untuk sumber data REST API mencakup hal-hal berikut:

#List

Petakan antarmuka untuk melihat daftar sumber daya.

#Get

Petakan antarmuka untuk melihat detail sumber daya.

#Create

Petakan antarmuka untuk membuat sumber daya.

#Update

Petakan antarmuka untuk memperbarui sumber daya.

#Destroy

Petakan antarmuka untuk menghapus sumber daya.

Antarmuka List dan Get wajib dikonfigurasi.

#Debugging API

#Integrasi Parameter Permintaan

Contoh: Konfigurasikan parameter paginasi untuk API List. Jika API pihak ketiga tidak mendukung paginasi secara native, NocoBase akan melakukan paginasi berdasarkan data daftar yang diambil.

Harap dicatat bahwa hanya variabel yang telah ditambahkan di antarmuka yang akan berlaku.

Anda dapat mengklik "Try it out" untuk melakukan debugging dan melihat hasil respons.

#Transformasi Format Respons

Format respons dari API pihak ketiga mungkin tidak sesuai dengan standar NocoBase, sehingga perlu diubah agar dapat ditampilkan dengan benar di antarmuka pengguna.

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

Deskripsi proses debugging

#Variabel

Sumber data REST API menyediakan tiga jenis variabel untuk integrasi API:

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

#Variabel Sumber Data Kustom

#Permintaan NocoBase

• Params: Parameter kueri URL (Search Params), yang bervariasi tergantung pada antarmuka.
• Headers: Header permintaan kustom, terutama menyediakan informasi X- spesifik dari NocoBase.
• Body: Isi permintaan (request body).
• Token: Token API untuk permintaan NocoBase saat ini.

#Respons Pihak Ketiga

Saat ini, hanya body respons yang tersedia.

Berikut adalah variabel yang tersedia untuk setiap antarmuka:

#List

#Get

#Create

#Update

#Destroy

#Konfigurasi Bidang

Metadata bidang (Fields) diekstraksi dari data antarmuka CRUD sumber daya yang diadaptasi untuk berfungsi sebagai bidang koleksi.

Ekstrak metadata bidang.

Bidang dan pratinjau.

Edit bidang (serupa dengan sumber data lainnya).

#Menambahkan Blok Sumber Data REST API

Setelah koleksi dikonfigurasi, Anda dapat menambahkan blok ke antarmuka.