Cara Menetapkan Enumerasi untuk Field di Apidog (String, Array, dll)

Halo! Jika Anda mendalami desain API dengan Apidog dan ingin membuat antarmuka Anda sangat jelas, menyiapkan enumerasi (atau enum) adalah suatu keharusan. Enum memungkinkan Anda mendefinisikan sekumpulan nilai tetap untuk suatu bidang—seperti “aktif,” “dibekukan,” atau “dihapus” untuk status pengguna—memastikan pengembang hanya memilih dari opsi-opsi tersebut. Ini mencegah kesalahan yang mengganggu dan menjaga dokumentasi API Anda tetap tajam. Dalam panduan percakapan ini, kita akan menjelajahi cara mengatur enumerasi untuk string, array, dan lainnya di Apidog, menggunakan UI intuitif dan fitur bertenaga AI-nya. Baik Anda seorang pemula atau pengembang berpengalaman, Anda akan mengatur enumerasi Apidog seperti seorang profesional dalam waktu singkat. Mari kita mulai!

Mengapa Menggunakan Enumerasi di Apidog?

Enumerasi ibarat pagar pembatas untuk bidang API Anda. Bayangkan bidang “status pengguna” di mana hanya “aktif,” “dibekukan,” atau “dihapus” yang valid. Tanpa enum, pengembang mungkin secara tidak sengaja meneruskan “tidak aktif” atau “diblokir,” menyebabkan API Anda macet. Dengan mengatur enumerasi Apidog, Anda secara eksplisit mencantumkan nilai-nilai yang diizinkan, membuat dokumentasi Anda jelas dan mengurangi kesalahan. Selain itu, fitur data Mock Apidog secara otomatis menghormati enum ini, menghasilkan data pengujian yang sesuai dengan aturan Anda. Baik itu string seperti “pending” atau array izin tertentu, enum menyederhanakan kolaborasi dan menjaga API Anda tetap kuat.

Apidog, platform yang kuat untuk desain, debugging, dan pengujian API, mendukung enum untuk berbagai tipe data, termasuk string, integer, angka, dan array. Anda bahkan dapat menambahkan deskripsi untuk setiap nilai agar lebih jelas. Mari kita selami cara mengaturnya, mulai dari string dasar hingga array kompleks, dan jelajahi bagaimana AI dan model yang dapat digunakan kembali dapat membuat hidup Anda lebih mudah.

Menyiapkan Enumerasi Dasar di Apidog

Mari kita mulai dengan kasus paling sederhana: mengatur enumerasi untuk bidang string atau angka, seperti status pengguna atau status pesanan. Berikut caranya:

1. Buka Editor Antarmuka:

• Di Apidog, navigasikan ke proyek Anda dan buka antarmuka (endpoint) yang sedang Anda kerjakan. Temukan bidang yang ingin Anda batasi, seperti user_status di badan permintaan atau respons.

2. Pilih Tipe Data:

• Di pengaturan bidang, pilih tipe data dari dropdown—biasanya string (misalnya, untuk “aktif”), integer, atau number. Misalnya, pilih string untuk user_status.

3. Akses Pengaturan Lanjutan:

• Klik tombol Pengaturan Lanjutan di samping tipe bidang. Ini akan membuka panel tempat Anda dapat mengkonfigurasi enum.

4. Tambahkan Nilai Enumerasi:

• Di bagian Nilai Enumerasi, masukkan nilai yang diizinkan, satu per baris. Untuk user_status, Anda mungkin menambahkan:
• active (Deskripsi: “Pengguna aktif dan dapat masuk”)
• frozen (Deskripsi: “Akun pengguna ditangguhkan sementara”)
• deleted (Deskripsi: “Akun pengguna dihapus secara permanen”)
• Secara opsional, tambahkan deskripsi untuk setiap nilai agar dokumentasi lebih jelas.

5. Simpan dan Periksa Dokumentasi:

• Simpan perubahan Anda. Dalam dokumentasi API, Apidog akan menampilkan nilai-nilai ini sebagai satu-satunya opsi yang valid untuk bidang tersebut. Anggota tim akan melihat sesuatu seperti: “user_status harus salah satu dari [aktif, dibekukan, dihapus].”

Saat melakukan debugging di Apidog, Anda dapat memilih nilai enum ini langsung dari dropdown, memastikan permintaan pengujian Anda valid. Ini adalah cara sederhana untuk menjaga semua orang tetap sejalan!

Tips Pro: Gunakan fitur Edit Massal di panel enum untuk menempelkan beberapa nilai sekaligus, menghemat waktu untuk daftar yang panjang.

Menangani Enumerasi Array di Apidog

Enumerasi array sedikit lebih rumit tetapi sangat berguna untuk bidang seperti izin pengguna atau koordinat. Apidog mendukung dua jenis enum array: membatasi elemen array individual atau membatasi seluruh array ke kombinasi tertentu. Mari kita bahas.

Skenario 1: Membatasi Nilai Elemen Array

Misalkan Anda memiliki bidang permissions yang merupakan array string, di mana setiap string harus salah satu dari “read,” “write,” atau “delete.” Array yang valid bisa berupa ["read"], ["write", "delete"], atau ["read", "write", "delete"]. Berikut cara mengaturnya:

1. Atur Bidang ke Tipe Array:

• Di editor antarmuka, atur bidang (misalnya, permissions) ke tipe array.

2. Konfigurasi Tipe Sub-Elemen:

• Di bawah pengaturan array, Anda akan melihat opsi Tipe Sub-Elemen. Pilih string (atau tipe lain seperti integer).

3. Tambahkan Nilai Enum:

• Klik Pengaturan Lanjutan untuk sub-elemen. Di bagian Nilai Enumerasi, tambahkan:
• read (Deskripsi: “Akses hanya baca”)
• write (Deskripsi: “Akses tulis”)
• delete (Deskripsi: “Akses hapus”)

4. Opsional: Terapkan Keunikan:

• Di pengaturan lanjutan array, aktifkan Semua Elemen Harus Unik untuk mencegah duplikat (misalnya, ["read", "read"] menjadi tidak valid).

5. Simpan dan Uji:

• Simpan, dan dokumentasi akan menunjukkan elemen array dibatasi pada nilai-nilai ini. Data Mock akan menghasilkan array seperti ["read", "write"], dengan menghormati aturan enum dan keunikan.

Sebagai alternatif, Anda dapat mengedit Skema JSON secara manual di tab Pengaturan Lanjutan:

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": ["read", "write", "delete"]
  },
  "uniqueItems": true
}

Ini memastikan setiap elemen dalam array mematuhi enum.

Skenario 2: Membatasi Seluruh Nilai Array

Terkadang, Anda ingin seluruh array menjadi salah satu dari beberapa kombinasi tetap, seperti bidang coordinate yang hanya bisa [0, 0] atau [100, 100]. Berikut caranya:

1. Atur Bidang ke Tipe Array:

• Pilih array untuk bidang (misalnya, coordinate).

2. Edit Skema JSON:

• Di Pengaturan Lanjutan, beralihlah ke editor Skema JSON dan masukkan:

{
  "type": "array",
  "enum": [
    [0, 0],
    [100, 100]
  ]
}

• Ini membatasi bidang hanya pada array ini—tidak ada kombinasi lain seperti [0, 100] yang diizinkan.

3. Simpan dan Verifikasi:

• Simpan, dan dokumentasi akan mencantumkan [0, 0] dan [100, 100] sebagai satu-satunya nilai yang valid. Data Mock akan secara acak memilih salah satu dari array ini.

Pendekatan ini kurang umum tetapi kuat untuk kasus penggunaan tertentu, seperti pengaturan yang telah ditentukan atau struktur data tetap.

Menggunakan AI untuk Menyederhanakan Pengaturan Enumerasi

Menulis Skema JSON untuk enum kompleks, terutama array, bisa terasa seperti bergulat dengan sintaksis. Untungnya, fitur AI Apidog hadir untuk membantu! Ini memungkinkan Anda mendeskripsikan persyaratan enum Anda dalam bahasa sederhana, dan itu menghasilkan konfigurasi yang benar.

1. Aktifkan AI di Apidog:

• Buka Pengaturan Tim > Fitur AI dan aktifkan bantuan AI. Periksa dokumen bantuan Apidog untuk detailnya.

2. Jelaskan Kebutuhan Anda:

• Di editor antarmuka, buka panel obrolan AI dan ketik sesuatu seperti:

coordinate[1, 2][3, 4]

• Atau untuk string: “Batasi status menjadi pending, paid, atau completed.”

3. Pratinjau dan Terapkan:

• AI menghasilkan Skema JSON, seperti:

{
  "type": "array",
  "enum": [
    [1, 2],
    [3, 4]
  ]
}

• Tinjau hasilnya, lalu klik Terapkan untuk menambahkannya ke bidang Anda.

4. Uji:

• Periksa dokumentasi untuk memastikan enum sudah benar. Coba debugging dengan nilai enum di antarmuka Apidog.

AI adalah penyelamat untuk skema kompleks atau ketika Anda tidak yakin tentang sintaksis JSON. Ini lebih cepat daripada mencari di Google dan memastikan akurasi.

Data Mock dan Enumerasi

Salah satu fitur paling keren Apidog adalah bagaimana ia mengintegrasikan enum dengan data Mock. Setelah Anda mengatur enum, layanan Mock Apidog secara otomatis menghasilkan data pengujian yang menghormati batasan Anda. Misalnya:

• Enum String: Jika status dibatasi pada ["active", "frozen", "deleted"], data Mock akan secara acak memilih salah satu dari nilai-nilai ini.
• Enum Array dengan Elemen Unik: Untuk array permissions dengan ["read", "write", "delete"] dan keunikan diaktifkan, Anda mungkin mendapatkan ["read", "write"] tetapi tidak pernah ["read", "read"].
• Enum Array Tetap: Bidang coordinate dengan [[0, 0], [100, 100]] hanya akan mengembalikan salah satu dari array yang persis sama.

Ini memastikan data pengujian Anda selaras dengan spesifikasi API Anda, membuat debugging dan kolaborasi lebih lancar. Untuk mengaktifkan data Mock, alihkan opsi **Mock** di editor antarmuka dan pratinjau hasilnya.

Mendefinisikan Model Enumerasi yang Dapat Digunakan Kembali

Jika enum yang sama muncul di beberapa endpoint—seperti user_status dalam API pembuatan, pembaruan, dan daftar pengguna—mendefinisikannya kembali setiap kali sangat merepotkan. Apidog memungkinkan Anda membuat model data yang dapat digunakan kembali untuk menjaga konsistensi.

1. Buat Model Data:

• Buka Model Data di proyek Apidog Anda.
• Klik Model Baru, beri nama (misalnya, UserStatusEnum), dan atur node root ke string.
• Di Pengaturan Lanjutan, tambahkan nilai enum seperti active, frozen, deleted dengan deskripsi opsional.

2. Referensi Model:

• Di antarmuka mana pun, atur tipe bidang ke Referensi dan pilih UserStatusEnum.

3. Perbarui Sekali, Sinkronkan di Mana Saja:

• Jika Anda perlu menambahkan status baru (misalnya, suspended), perbarui model UserStatusEnum, dan semua endpoint yang mereferensikannya akan diperbarui secara otomatis.

Pendekatan ini menghemat waktu dan memastikan konsistensi di seluruh proyek Anda. Ini sempurna untuk tim di mana banyak pengembang mengandalkan enum yang sama.

Memecahkan Masalah Umum Enumerasi

• Enum Tidak Muncul di Dokumen? Simpan antarmuka dan segarkan halaman dokumentasi. Pastikan bidang ditandai sebagai **Wajib** jika diperlukan.
• Data Mock Mengabaikan Enum? Periksa apakah nilai enum diatur dengan benar di **Pengaturan Lanjutan** atau Skema JSON. Matikan dan nyalakan opsi **Mock**.
• Kesalahan Enum Array? Untuk enum tingkat elemen, pastikan tipe sub-elemen diatur dengan benar. Untuk array tetap, verifikasi sintaksis Skema JSON.
• AI Tidak Menghasilkan Skema? Perjelas perintah Anda (misalnya, “Batasi ke array yang persis sama”) dan pastikan AI diaktifkan di **Pengaturan Tim**.

Mengapa Enumerasi Membuat Apidog Bersinar

Enumerasi Apidog adalah pengubah permainan untuk desain API. Mereka memperjelas batasan bidang, mengurangi kesalahan, dan meningkatkan keterbacaan dokumentasi. Fitur AI menyederhanakan pengaturan kompleks, sementara model yang dapat digunakan kembali memastikan konsistensi. Integrasi data Mock berarti pengujian Anda selalu sesuai dengan spesifikasi. Dibandingkan dengan alat seperti Postman, editor visual dan AI Apidog membuat pengaturan enum lebih intuitif, terutama untuk array. Pengguna memuji Apidog karena “membuat dokumen API anti-gagal,” dan dengan dukungan enum, mudah untuk melihat alasannya.

Kesimpulan

Mengatur enumerasi Apidog sangat mudah, baik Anda membatasi string, angka, atau array. Dari editor visual hingga pembuatan Skema JSON bertenaga AI, Apidog membuat API Anda kuat dan ramah pengembang. Coba buat model enum yang dapat digunakan kembali atau gunakan AI untuk mempercepat, dan bagikan tips Anda di kolom komentar. Mari kita buat desain API lebih lancar bersama!