Banyak pengembang yang merasa blog kami sebelumnya, "Mocking an API in ONE Minute," bermanfaat, dan Anda mungkin juga. Blog tersebut membahas cara cepat untuk melakukan mocking API, tetapi hanya menyentuh permukaannya saja. Saat saya menggali lebih dalam ke Apidog, saya menemukan fitur tambahan yang membuat mocking data yang lebih kompleks menjadi lebih cepat.
Menangani API dengan Data JSON Kompleks
Mari kita mulai dengan cara mengimpor Swagger API ke Apidog untuk melakukan mocking data JSON. Dengan cara ini, Anda dapat menghasilkan data mock tanpa menulis skrip apa pun.
Namun, beberapa bidang bisa jadi sulit untuk di-mock tanpa konfigurasi tambahan. Misalnya:
- Bidang Enum dengan beberapa kemungkinan nilai, sering digunakan untuk bidang status.
- Array dengan panjang tetap, seperti tabel di mana setiap baris memiliki beberapa atribut dan satu halaman mungkin menampilkan 20 atau 50 baris.
- Objek yang mereferensikan skema, seperti yang diizinkan oleh spesifikasi OpenAPI, di mana suatu objek atau bagian dari objek mengacu pada skema.
Untungnya, dengan Apidog, Anda dapat melakukan mocking bidang JSON kompleks ini hanya dalam dua menit.
Bagaimana Cara Melakukan Mocking API dengan Data JSON Kompleks dengan Cepat?
Berikut adalah proses tiga langkah sederhana untuk melakukan mocking API kompleks menggunakan Apidog:
- Impor definisi API.
- Sesuaikan aturan mock API untuk bidang tertentu.
- Dapatkan URL mock.
Semudah itu. Mari kita bahas satu per satu.
Langkah 1: Impor Definisi API
Anda hanya memerlukan file OpenAPI JSON atau YAML. Impor ke Apidog, dan Anda siap untuk memulai.
Langkah 2: Sesuaikan Aturan Mock API untuk Bidang Tertentu
Nilai Enum:
Dalam contoh API kami, bidang 'status' memiliki tiga opsi: available, pending, dan sold. Kami ingin data mock kami hanya mencerminkan salah satu dari nilai-nilai ini.
Klik 'Advanced settings' di bidang 'Status', aktifkan tombol 'Enum', dan tambahkan nilai enum. Sekarang, bidang ini hanya akan melakukan mocking salah satu dari nilai-nilai ini.
Array dengan panjang tetap:
Untuk bidang array 'PhotoUrls', kita membutuhkan tepat lima item.
Di 'Advanced settings' dari bidang 'PhotoUrls', sesuaikan pengaturan 'Element Limit'. Atur 'minItems' dan 'maxItems' menjadi 5.
Objek yang direferensikan skema:
Apidog mendukung skema sesuai spesifikasi OpenAPI. Jika suatu objek mengacu pada skema, Apidog akan melakukan mocking sesuai dengan itu. Misalnya, Anda dapat mereferensikan skema untuk bidang 'Category'.
Langkah 3: Dapatkan URL Mock API
Klik ‘Save', dan beralih ke tab 'Endpoint'. Salin URL di bawah bagian "Local Mock", yang dimulai dengan "127.0.0.1".
Tempel URL ke browser Anda, dan Anda selesai.
Bidang Penting
Saat Anda memeriksa data yang di-mock, Anda akan melihat:
- PhotoUrls memiliki tepat 5 item, semuanya dengan URL gambar yang valid.
- Status dibatasi hanya pada salah satu nilai enum (sold, pending, atau available).
- Category mengacu pada skema yang benar.
Bidang lain, seperti city dan createdAt, di-mock secara otomatis.
Dan jika Anda me-refresh URL, data mock akan diperbarui.
Apidog Mendukung Mocking Skema JSON untuk API
Apidog sepenuhnya kompatibel dengan OpenAPI 3.0, yang menggunakan Skema JSON untuk menentukan struktur data API. Semua atribut Skema JSON didukung di Apidog, termasuk:
- Rentang panjang string, format, dan pola (regex)
- Nilai integer minimum dan maksimum
- Pengaturan hanya baca/hanya tulis
Tidak hanya JSON, Apidog juga mendukung mocking XML. Anda bahkan dapat menyesuaikan nama tag dan awalan XML.
Berkat Skema JSON, Anda dapat menghasilkan data mock kompleks apa pun hanya dengan beberapa klik menggunakan Apidog—tanpa perlu coding.
