Advertisement
  1. Code
  2. JSON

Menjalankan REST API Tiruan Menggunakan json-server

by
Read Time:6 minsLanguages:

Indonesian (Bahasa Indonesia) translation by ⚡ Rova Rindrata (you can also view the original English article)

Dalam tutorial ini, Anda akan melihat cara untuk mulai menyiapkan dan menggunakan server REST API tiruan menggunakan json-server, yang dapat digunakan ketika mengembangkan aplikasi mobile atau web. Tutorial ini mengasumsikan bahwa Anda memiliki pengetahuan dasar mengenai JSON dan HTTP requests.

Apa itu REST?

REST merupakan singkatan dari Representational State Transfer. Yang merupakan gaya arsitektur untuk merancang aplikasi yang saling terhubung. Dengan menggunakan HTTP sederhana untuk memungkinkan komunikasi antar mesin. Jadi, alih-alih menggunakan URL untuk memanipulasi beberapa informasi pengguna, REST mengirimkan permintaan HTTP seperti GET, POST, DELETE, dll ke URL untuk memanipulasi data.

Sebagai contoh, sebagai ganti membuat sebuah permintaan GET ke URL seperti /deleteuser?id=10, permintaannya akan menjadi seperti DELETE /user/10.

Mengapa kita membutuhkan sebuah REST API Tiruan?

REST API membentuk back-end untuk aplikasi mobile dan web. Ketika mengembangkan aplikasi, kadang-kadang Anda tidak memiliki REST API yang siap digunakan untuk tujuan pengembangan. Untuk melihat mobile atau web app beraksi, kita memerlukan server yang melempar beberapa data JSON dummy.

Saat itulah REST API tiruan berfungsi. json-server menyediakan fungsi untuk mendirikan sebuah server REST API tiruan dengan usaha minimal.

Memulai

Untuk mulai menggunakan json-server, install paket menggunakan Node Package Manager (npm).

Buat file JSON dummy dengan beberapa data sesuai kebutuhan Anda. Sebagai contoh, saya perlu beberapa data JSON dengan informasi pengguna seperti id, name, location, dll. Jadi saya akan membuat file bernama info.json dengan informasi JSON sebagai berikut:

Dari terminal, jalankan server json dengan info.json sebagai sumber data dan Anda harus menjalankan REST API di http://localhost:3000.

Pengujian Endpoint REST API

Sejak server REST API tiruan kita berjalan, mari kita lihat bagaimana cara mengakses REST API menggunakan klien. Saya menggunakan klien Postman REST untuk membuat panggilan API.

Permintaan GET

Mari kita mulai dengan membuat permintaan GET ke URL REST. Di dalam file json, kita tetapkan sebuah endpoint users yang berisi informasi yang berhubungan dengan pengguna. Ketika membuat permintaan GET ke URL http://localhost:3000/users, harus menampilkan data yang ada.

Permintaan POST

Untuk menambahkan data baru ke data yang sudah ada, kita akan membuat permintaan POST ke URL http://localhost:3000/users. Permintaan POST akan terlihat seperti ini:

POST RequestPOST RequestPOST Request

Cobalah melakukan permintaan GET dan Anda seharusnya memiliki data baru yang ditambahkan dalam file info.json.

Permintaan DELETE

Untuk menghapus entri dari data json-server, Anda perlu mengirim permintaan DELETE ke endpoint API dengan Id pengguna. Misalnya, untuk menghapus pengguna dengan Id 1, Anda harus mengirim permintaan DELETE ke endpoint http://localhost:3000/users/1. Setelah dihapus, cobalah melakukan permintaan GET, dan pengguna dengan Id 1 seharusnya tidak ada lagi di JSON.

Permintaan PATCH

Untuk memperbarui entri yang sudah ada, Anda perlu mengirim permintaan PATCH dengan rincian yang perlu diperbarui untuk entri tertentu. Sebagai contoh, dalam rangka untuk memperbarui rincian bagi pengguna dengan Id 2, kita akan mengirim permintaan PATCH ke URL http://localhost:3000/users/2 seperti yang ditunjukkan:

Patch Request Patch Request Patch Request

Mencari dari REST API json-server

Dengan menggunakan REST API dari json-server, Anda dapat mencari melalui data untuk menemukan data berdasarkan kriteria tertentu. Sebagai contoh, untuk menemukan pengguna dengan nama tertentu, Anda perlu mengirim permintaan GET ke URL REST API seperti yang ditunjukkan:

Sending a GET request to the REST API URL Sending a GET request to the REST API URL Sending a GET request to the REST API URL

Seperti yang terlihat pada gambar di atas, mengirimkan permintaan GET ke URL http://localhost:3000/users?name=Shona akan menampilkan pengguna dengan nama Shona. Demikian pula, untuk mencari pengguna dengan field lain, Anda perlu menambahkan field ke query string.

Dalam melaksanakan pencarian teks penuh di endpoint REST API, Anda perlu menambahkan string pencarian bersamaan dengan parameter q pada endpoint. Sebagai contoh, untuk mencari pengguna dengan info yang berisi string pencarian s, permintaan akan terlihat seperti:

Full Text Search in json-server REST APIFull Text Search in json-server REST APIFull Text Search in json-server REST API

Menangani Paginasi

Ketika menampilkan data grid yang dipaginasi, akan diperlukan untuk mengambil beberapa data berdasarkan paginasi. Dalam skenario tersebut, json-server menyediakan fungsi untuk mempaginasi data JSON. Secara default, jumlah data dari json-server adalah 10. Kita dapat menentukan batas ini menggunakan parameter _limit secara eksplisit.

Sebuah permintaan GET ke URL di atas akan menampilkan lima record. Sekarang, untuk paginasi data, kita perlu menambahkan parameter _page ke URL. _page mendefinisikan halaman mana yang harus diambil untuk menampilkan data.

Sebuah permintaan GET ke URL di atas akan menampilkan halaman kedua dari data set dengan lima record per halaman. Dengan mengubah variabel _page, kita dapat mengambil record dari halaman yang diperlukan.

Menangani Penyortiran

json-server menyediakan fungsi untuk menyortir data yang diambil. Kita dapat mengurutkan data dengan memberikan nama kolom yang perlu disortir dan urutan di mana data perlu diurutkan. Secara default, data diurutkan dalam urutan meningkat. Kita dapat memberikan nama kolom dalam endpoint URL menggunakan kata kunci _sort dan menentukan urutan menggunakan kata kunci _order. Berikut adalah contoh URL:

URL di atas akan mengurutkan data berdasarkan kolom Id, dan akan diurutkan dalam urutan menurun.

Menangani Operator

json-server juga menyediakan fungsi untuk mendukung operator seperti mencari sebuah entri dengan Id di kisaran antara dua nilai atau entri yang cocok dengan reguler expression tertentu.

Untuk menemukan sebuah entri dalam kisaran tertentu, kita dapat memanfaatkan operator _gte dan _lte. Misalnya, untuk menemukan pengguna dengan Id lebih besar dari 1 dan kurang dari 2, buat permintaan GET ke URL http://localhost:3000/users?id_gte=1&id_lte=2 seperti yang ditunjukkan:

Handling Less Than Greater Than OperatorsHandling Less Than Greater Than OperatorsHandling Less Than Greater Than Operators

Jika kita ingin mencari nama yang dimulai dengan huruf tertentu, kita dapat menggunakan regular expressions. Misalnya, untuk mencari nama-nama yang dimulai dengan kata sa, kita akan memanfaatkan operator _like dan membuat permintaan GET ke URL http://localhost:3000/users?name_like=^sa.

Handling Regular Expressions In OperatorsHandling Regular Expressions In OperatorsHandling Regular Expressions In Operators

Kesimpulan

Dalam tutorial ini, Anda melihat bagaimana menggunakan REST API dari json-server untuk membuat database dummy untuk digunakan dengan cepat. Anda belajar bagaimana untuk mulai menggunakan json-server dan query URL untuk menambah, memperbarui, mengubah dan menghapus data. Anda melihat bagaimana melakukan paginasi, mengurutkan dan mencari dari data dummy. Anda juga melihat bagaimana menggunakan operator untuk mencari entri menggunakan regular expressions.

Apakah Anda pernah menggunakan json-server atau server REST API lainnya untuk pembuatan data dummy? Bagaimana pengalaman Anda? Beri tahu kami pengalaman Anda di komentar di bawah.

Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.