Saat mendesain API di Apidog, Anda mungkin menghadapi situasi yang mengharuskan penambahan sejumlah besar parameter permintaan. Bayangkan sebuah endpoint yang membutuhkan lusinan atau bahkan ratusan parameter. Menambahkan setiap parameter satu per satu di bagian "Edit" bisa jadi rumit, memakan waktu, dan rentan terhadap kesalahan.
Untungnya, Apidog menawarkan cara untuk menambahkan parameter secara massal, membuat prosesnya lebih lancar dan efisien.
Dalam artikel ini, kita akan menjelajahi berbagai metode untuk menambahkan parameter permintaan secara massal. Mari kita selami detailnya.
Metode 1: Menggunakan Fitur Edit Massal
Ketika tipe parameter body adalah form-data atau x-www-form-urlencoded, Anda dapat menggunakan fitur "Edit Massal" untuk menambahkan parameter permintaan.
Akses Fungsi Edit Massal:
Di daftar parameter, cari tombol "Edit Massal" di sudut kanan atas. Mengklik tombol ini akan membuka kotak pengeditan teks tempat Anda dapat memasukkan parameter secara massal.
Masukkan Parameter dalam Format CSV:
Parameter harus dalam format CSV. Misalnya, untuk parameter form-data, format yang diperlukan adalah:
Nama Parameter, Tipe, Wajib, Contoh Nilai, Content-Type, Deskripsi
Setiap item yang dipisahkan oleh koma dapat dibiarkan kosong jika perlu. Anda dapat memanfaatkan alat AI untuk mengatur data ini dan meminimalkan kesalahan. Berikut adalah contohnya:
email, string, false, user@gmail.com, text/plain, Alamat email Pengguna
password, string, false, ********, text/plain, Kata sandi Pengguna
Setelah memasukkan parameter, klik tombol "OK" untuk menghasilkan parameter permintaan yang sesuai.
Metode 2: Menghasilkan Parameter dari Format yang Ada
Saat bekerja dengan tipe parameter body seperti JSON atau XML, Anda dapat menempelkan konten langsung dalam format tertentu untuk menghasilkan parameter secara otomatis.
Gunakan JSON untuk Menambahkan Parameter Secara Massal:
Klik tombol "Hasilkan dari JSON" di daftar parameter, yang membuka kotak pengeditan teks tempat Anda dapat menempelkan atau memasukkan objek JSON.
Komentar dalam JSON dapat dikenali sebagai deskripsi parameter. Anda dapat menentukan mode timpa atau konvensi penamaan sesuai kebutuhan. Berikut adalah contohnya:
{"region_id": "82","email": "b.wawjn@gmail.com", // Email Pengguna"sales_channel_id": "12","customer_id": "98","country_code": "70", // Kode negara"context": {"ip": "::1","user_agent": "Chrome"
},// Parameter lainnya...
}
Anda dapat melihat pratinjau data JSON yang dimasukkan sebelum mengonfirmasi.
Setelah mengedit, klik tombol "OK" untuk menghasilkan parameter permintaan yang sesuai.
Jika tombol "Hasilkan Otomatis" diaktifkan, contoh permintaan juga dihasilkan.
Gunakan XML untuk Menambahkan Parameter Secara Massal:
Mirip dengan JSON, Anda juga dapat menempelkan data XML Anda ke dalam kotak pengeditan. Klik tombol "OK" untuk menghasilkan parameter permintaan yang relevan. Berikut adalah contohnya:
Impor dari Database:
Anda juga memiliki opsi untuk mengimpor parameter dari database dengan menghubungkan dan memilih tabel data yang diinginkan. Komentar bidang di database dapat digunakan sebagai deskripsi atau nama.
Atau, Anda dapat memasukkan pernyataan SQL DDL untuk menghasilkan parameter (saat ini hanya mendukung MySQL), seperti ini:
CREATE TABLE
carts
(
id int NOT NULL AUTO_INCREMENT,
region_id varchar(10) DEFAULT NULL,
email varchar(255) DEFAULT NULL,
sales_channel_id varchar(10) DEFAULT NULL,
customer_id varchar(10) DEFAULT NULL,
country_code varchar(10) DEFAULT NULL,PRIMARY KEY (
id
)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
Metode 3: Menambahkan Parameter/Model Data Umum
Apidog memungkinkan Anda membuat dan menggunakan templat parameter yang telah ditentukan sebelumnya, memungkinkan penggunaan kembali di seluruh API serupa, terutama melalui parameter dan model data umum.
Menambahkan Parameter Umum:
Di bilah navigasi kiri, pilih "Pengaturan," lalu klik "Parameter Umum" untuk menambahkan parameter yang sering Anda gunakan.
Saat Anda perlu menggunakan parameter umum di API, cukup klik kotak input parameter, dan panel pilihan akan muncul bagi Anda untuk memilih parameter yang telah ditentukan sebelumnya dengan cepat.
Menambahkan Skema:
Temukan opsi "Skema" di bilah navigasi kiri, klik tombol "Skema Baru", masukkan nama dan deskripsi model, lalu tambahkan bidang dan tentukan tipe setiap bidang, contoh nilai, dan deskripsi.
Parameter skema juga dapat dihasilkan melalui JSON atau JSON Schema, seperti yang disebutkan dalam Metode 2.
Saat Anda perlu menggunakan skema dalam permintaan atau respons, cukup klik tipe (misalnya, objek) dan pilih "Referensi skema lain" dari daftar pop-up.
Pilih skema yang telah ditentukan sebelumnya dari daftar dan parameter secara otomatis diisi ke dalam API.
Jika Anda perlu menambahkan atau memodifikasi beberapa parameter, Anda dapat memodifikasinya di "Skema Data" yang sesuai, atau dereferensi. Saat dereferensi, parameter permintaan tidak lagi bergantung pada model data umum, tetapi ada secara independen dan menjadi milik eksklusif API saat ini.
Metode 4: Mengimpor Perintah cURL
Apidog mendukung impor langsung perintah cURL, memungkinkan pengaturan cepat parameter permintaan, terutama untuk API dari platform pihak ketiga yang menyediakan perintah cURL untuk tujuan pengujian, seperti Shopify API.
Untuk mengimpor perintah cURL, cukup salin perintah yang diberikan dan tempelkan ke bilah alamat API baru. Apidog akan secara otomatis mengurai perintah cURL dan menghasilkan parameter permintaan yang sesuai.
Anda juga dapat mengklik tombol "+" di sebelah kotak pencarian di proyek Anda, pilih "Impor cURL," tempelkan perintah yang disalin ke dalam dialog, dan klik "OK."
Setelah disimpan sebagai API, body permintaan JSON akan secara otomatis distrukturkan agar sesuai dengan dokumentasi API.
Kesimpulan
Artikel ini telah menyajikan berbagai metode untuk menambahkan parameter permintaan secara massal di Apidog. Anda dapat menggunakan fungsionalitas edit massal untuk data CSV, menghasilkan parameter dari format JSON atau XML, mengimpor dari database, memanfaatkan templat parameter yang telah ditentukan sebelumnya, atau langsung mengimpor perintah cURL. Pendekatan yang beragam ini memungkinkan Anda mengelola parameter permintaan API Anda secara efisien sesuai dengan kebutuhan Anda.
