Alat Terbaik untuk Pengujian API Berbasis Data dengan CSV atau JSON

Menguji satu titik akhir API sekali itu mudah. Anda mengirim permintaan, meninjau respons, dan mengonfirmasi semuanya berfungsi seperti yang diharapkan. Tantangan sebenarnya dimulai ketika Anda perlu menjalankan pengujian yang sama terhadap puluhan—atau bahkan ratusan—set data yang berbeda. Memperbarui parameter secara manual dan mengirim permintaan berulang kali tidak hanya memakan waktu, tetapi juga rentan terhadap kesalahan dan tidak mungkin untuk diskalakan.

Di sinilah pengujian API berbasis data berperan. Daripada menulis ulang atau mengirim ulang permintaan secara manual, Anda menentukan satu kasus uji dan menjalankannya secara otomatis dengan beberapa set data masukan. Hasilnya adalah cakupan yang lebih luas, akurasi yang lebih tinggi, dan upaya manual yang jauh lebih sedikit.

Untuk melakukannya secara efisien, Anda memerlukan alat yang tepat. Apidog menonjol dengan menawarkan dukungan asli untuk pengujian berbasis data menggunakan file CSV dan JSON. Sebagai platform pengembangan dan pengujian API serba ada, Apidog memungkinkan Anda mengikat file data eksternal ke skenario pengujian dan menjalankannya berulang kali, memvalidasi setiap respons secara otomatis.

Baik Anda menguji alur login dengan pengguna berbeda, API pencarian dengan kueri bervariasi, atau pembuatan sumber daya dengan berbagai kombinasi parameter, Apidog menghilangkan pekerjaan berulang dan membantu Anda mencapai pengujian API yang andal dan komprehensif dalam waktu singkat.

tombol

Sekarang, mari kita selami panduan lengkap, langkah demi langkah tentang menguasai pengujian API berbasis data menggunakan Apidog dengan CSV dan JSON.

Panduan Langkah-demi-Langkah untuk Pengujian API Berbasis Data dengan CSV dan JSON

Mari kita bahas seluruh proses, mulai dari penyiapan hingga eksekusi, menggunakan contoh konkret. Kita akan menguji titik akhir API pendaftaran pengguna.

Langkah 1: Tentukan Permintaan API Dasar Anda

Pertama, Anda membuat permintaan API yang akan berfungsi sebagai templat pengujian Anda.

Di Apidog, buat permintaan baru ke titik akhir pendaftaran pengguna Anda (misalnya, POST /api/v1/users).
Siapkan header (misalnya, Content-Type: application/json).
Di tab Body, buat payload JSON Anda. Alih-alih mengkodekan nilai secara langsung, Anda akan menggunakan sintaks variabel dinamis Apidog {{}} untuk membuat placeholder.

{
  "username": "{{username}}",
  "email": "{{email}}",
  "password": "{{password}}",
  "role": "{{role}}"
}

Perhatikan placeholder: {{username}}, {{email}}, dll. Apidog akan mengganti ini dengan nilai aktual dari file data Anda selama eksekusi.

Langkah 2: Buat File Data Pengujian Anda (CSV atau JSON)

Sekarang, buat file eksternal yang akan memasukkan data ke dalam placeholder Anda.

Opsi A: Menggunakan File CSV

CSV sangat cocok untuk data tabular. Buat file user_data.csv:

username,email,password,role,expected_status
john_doe,john@example.com,SecurePass123!,user,201
jane_smith,jane@example.com,AnotherPass456!,admin,201
bad_user,not-an-email,short,user,400
duplicate_user,john@example.com,SomePass789!,user,409

Baris pertama mendefinisikan nama variabel yang cocok dengan placeholder Anda (username, email, dll.), ditambah expected_status tambahan untuk validasi.
Setiap baris berikutnya adalah kasus uji dengan data untuk eksekusi tersebut.

Opsi B: Menggunakan File JSON

JSON sangat ideal untuk struktur data yang bertingkat atau lebih kompleks. Buat file user_data.json:

[
  {
    "username": "john_doe",
    "email": "john@example.com",
    "password": "SecurePass123!",
    "role": "user",
    "expected_status": 201
  },
  {
    "username": "jane_smith",
    "email": "jane@example.com",
    "password": "AnotherPass456!",
    "role": "admin",
    "expected_status": 201
  },
  {
    "username": "bad_user",
    "email": "not-an-email",
    "password": "short",
    "role": "user",
    "expected_status": 400
  }
]

Langkah 3: Konfigurasi Pengujian Berbasis Data di Apidog

Di sinilah alur kerja terintegrasi Apidog bersinar.

Buka tab "Test" di dalam dashboard Anda (atau buat kasus uji baru dalam test suite).

2. Klik untuk menambahkan langkah pengujian baru dan pilih permintaan POST /api/v1/users Anda.

3. Unggah data pengujian: Klik "Test Data" > "+New" untuk mengunggah file user_data.csv atau user_data.json Anda. Apidog akan menguraikannya dan menampilkan pratinjau baris data.

antarmuka impor data pengujian di Apidog

mengimpor data CSV atau JSON untuk pengujian API

4. Petakan Variabel (jika diperlukan): Apidog secara otomatis memetakan nama kolom (CSV) atau kunci properti (JSON) ke placeholder {{variable}} dalam permintaan Anda. Verifikasi pemetaan sudah benar.

Langkah 4: Tulis Assertion Menggunakan Variabel Data Anda

Kekuatan sebenarnya berasal dari memvalidasi hasil yang diharapkan yang berbeda berdasarkan data masukan Anda. Di tab Test, Anda menulis assertion (juga disebut "asserts" atau "checks").

Yang terpenting, Anda dapat merujuk variabel data yang sama dari file Anda dalam assertion Anda.

Sebagai contoh, tambahkan assertion Response Status Code:

Nilai yang Diharapkan: {{expected_status}}

Ini berarti: "Untuk eksekusi uji pertama (john_doe), assertion kode status sama dengan 201. Untuk eksekusi ketiga (bad_user), assertion sama dengan 400." Assertion berubah secara dinamis dengan setiap iterasi.

Anda dapat menambahkan assertion yang lebih kompleks menggunakan JavaScript di bagian Script Apidog:

// Example: Validate response body for successful creation
pm.test("Status code is " + pm.variables.get("expected_status"), function () {
    pm.response.to.have.status(pm.variables.get("expected_status"));
});

// Only check for user ID if we expect a successful creation
if (pm.variables.get("expected_status") === 201) {
    pm.test("Response has user ID", function () {
        var jsonData = pm.response.json();
        pm.expect(jsonData.id).to.be.a('number');
        pm.expect(jsonData.username).to.eql(pm.variables.get("username"));
    });
}

Langkah 5: Jalankan Pengujian dan Analisis Hasilnya

Klik tombol Run. Apidog akan mengeksekusi satu langkah pengujian Anda beberapa kali, satu kali untuk setiap baris dalam file data Anda.

Laporan adalah Tempat Semuanya Bersatu:

Apidog menyajikan laporan yang jelas dan teragregasi yang menunjukkan:

Total Iterasi: (misalnya, "4/4 Lulus")
Rincian untuk setiap baris data: Anda dapat memperluas untuk melihat permintaan persis yang dikirim (dengan nilai substitusi aktual) dan respons yang diterima untuk iterasi spesifik tersebut.
Setiap kegagalan ditunjukkan pada baris data spesifik yang menyebabkan masalah. Apakah duplicate_user gagal karena statusnya bukan 409? Anda akan melihatnya secara instan.

Ini membuat debugging menjadi sangat efisien. Anda tidak perlu menebak kasus uji mana yang gagal; Anda tahu itu adalah iterasi dengan set data spesifik {"username": "duplicate_user", ...}.

Praktik Terbaik untuk Pengujian API Berbasis Data

Data Spesifik Lingkungan: Gabungkan pengujian berbasis data dengan Lingkungan Apidog. Anda mungkin memiliki variabel base_url di lingkungan Anda yang berubah dari staging ke produksi, sementara file CSV Anda berisi kasus uji yang berlaku untuk keduanya.
Data Pengujian yang Dapat Digunakan Kembali: Simpan file CSV/JSON Anda di tempat terpusat dalam proyek Apidog Anda. Beberapa test suite dapat mereferensikan file data yang sama, memastikan konsistensi.
Hasilkan File Data Secara Terprogram: Untuk skenario yang kompleks, gunakan skrip (Python, Node.js) untuk menghasilkan file test_data.csv Anda. Ini sangat baik untuk pengujian dengan data acak atau rentang nilai yang besar (misalnya, menguji paginasi dengan 100 kombinasi page dan limit yang berbeda).
Penyiapan/Pembersihan Pengujian: Gunakan skrip pra-permintaan Apidog dan fitur pembersihan pengujian (test teardown) bersama dengan pengujian berbasis data. Misalnya, sebelum setiap iterasi pengujian DELETE, Anda dapat menggunakan skrip pra-permintaan untuk membuat sumber daya yang akan dihapus.

Kesimpulan: Transformasi Alur Kerja Pengujian API Anda

Pengujian berbasis data di Apidog dengan file CSV/JSON mengalihkan Anda dari pemeriksaan manual dan berulang ke validasi otomatis dan komprehensif. Ini mewujudkan prinsip inti pengujian yang baik: menjadi teliti tanpa mengorbankan efisiensi.

Dengan mengeksternalkan data pengujian Anda, Anda membuat dokumen skenario pengujian yang hidup yang mudah dibaca, diperbarui, dan dipahami oleh siapa pun di tim Anda. Integrasi mulus metodologi ini oleh Apidog berarti tidak ada penyiapan yang rumit, hanya jalur yang lugas menuju API yang lebih tepercaya.

Berhentilah menguji API satu per satu. Unduh Apidog secara gratis hari ini, impor file CSV pertama Anda, dan rasakan betapa kuat dan efisiennya pengujian API.

tombol