Mengonfigurasi Beberapa Contoh Body Permintaan

Apidog mendukung konfigurasi beberapa contoh untuk body permintaan bertipe JSON, XML, Raw, dan MsgPack. Fitur ini berguna untuk:

Mengonfigurasi contoh untuk berbagai skenario bisnis: Misalnya, permintaan normal vs. permintaan pengecualian.

Kepatuhan terhadap spesifikasi OAS 3.0/3.1: Mendukung ekspor spesifikasi OpenAPI standar.

Beralih dengan cepat antarcontoh: Berguna selama debugging dan pengujian otomatis.

Mengonfigurasi Beberapa Contoh Body Permintaan

Diperlukan Apidog versi 2.7.0 atau yang lebih baru.

Buat contoh body permintaan baru

Buka halaman Edit pada dokumentasi endpoint Anda.

Temukan bagian Request Body.

Klik tombol + Add untuk membuat contoh body permintaan baru.

Konfigurasikan contoh body permintaan

Nama Contoh (opsional): Jika dibiarkan kosong, nilai default-nya adalah Example 1, Example 2, dan seterusnya.

Nilai Contoh (wajib): Berikan data contoh aktual untuk body permintaan.

Deskripsi (opsional): Tambahkan deskripsi untuk menjelaskan contoh. Mendukung pemformatan Markdown untuk teks kaya.

OAS Key (opsional): Digunakan saat mengekspor spesifikasi OpenAPI. Jika tidak disediakan, nomor seri akan digunakan sebagai gantinya.

OAS Extensions (bidang kustom): Jika disediakan, ini akan dipertahankan selama ekspor.

Simpan & Gunakan contoh body permintaan

Setelah Anda menyimpan contoh, contoh tersebut tersedia untuk digunakan. Selama debugging, Anda dapat dengan mudah memilih dari berbagai contoh untuk menguji endpoint Anda.

Menggunakan contoh body permintaan selama debugging

TIP

Untuk body permintaan bertipe Raw, hanya nilai contoh pertama yang ditampilkan selama debugging.

Mengekstrak Parameter Permintaan sebagai Contoh

Ekstrak parameter permintaan sebagai contoh

Saat debugging, jika Anda telah mengonfigurasi body permintaan secara manual dan ingin menyimpannya sebagai contoh, cukup klik: Extract > Extract to "Request Example".

Pilih opsi Ekstraksi

Anda akan diminta memilih cara menyimpan parameter permintaan:

Timpa Contoh: Mengganti contoh yang sebelumnya disimpan.

Contoh Baru: Menyimpannya sebagai contoh yang benar-benar baru.

TIP

Nilai debugging saat ini akan secara otomatis diisikan ke dalam contoh secara default.

Skenario Penggunaan

Menggunakan Contoh Body Permintaan Selama Debugging

Buka halaman Run pada dokumentasi endpoint dan temukan bagian Auto-generate.

Klik menu dropdown untuk memilih contoh body permintaan. Contoh tersebut akan terisi secara otomatis.

Beralih contoh body permintaan selama debugging

Anda dapat beralih antarcontoh secara real-time dan mengirim permintaan dengan contoh yang dipilih.

Pengaturan Lanjutan

Klik ikon dropdown di sebelah Auto-generate untuk mengakses opsi berikut:

EXAMPLES: Pilih dari contoh body permintaan yang telah ditentukan sebelumnya.

Generate Each Time: Secara otomatis menghasilkan nilai acak berdasarkan aturan mock.

Preferensi Pembuatan Otomatis: Untuk konfigurasi yang lebih lanjutan, lihat Buat Permintaan.

Tampilan Dokumentasi

Untuk satu contoh body permintaan: Ditampilkan dalam tampilan yang disederhanakan tanpa menampilkan nama contoh.

Untuk beberapa contoh body permintaan: Memungkinkan peralihan antarcontoh dalam tata letak berdampingan, menampilkan nama contoh dan deskripsi Markdown.

Urutan Tampilan

Urutan tampilan untuk contoh body permintaan mengikuti prioritas berikut:

Nama Contoh > OAS Key > Nomor Seri (bertambah otomatis dari 1).

Item yang tidak kosong ditampilkan terlebih dahulu.

Kepatuhan OAS

OAS Key

OAS key mengontrol nama bidang contoh saat mengekspor spesifikasi OpenAPI.

Konfigurasi: Isi OAS Key untuk contoh body permintaan.

Aturan Ekspor:

Saat diisi: OAS key yang diberikan digunakan sebagai nama bidang di dalam objek examples.

Saat tidak diisi: Nomor seri (dimulai dari 1) secara otomatis digunakan sebagai nama bidang.

Saat diisi

Saat tidak diisi:

 "examples": {
   "example1": {
      "value": {
        "name": "Blake Keeling",
        "id": "165061",
        "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    },
    "example2": {
       "value": {
        "name": "Jolie Kutch",
        "id": "138164",
        "email": "Jolie_Kutch@hotmail.com"
      },
      "summary": "example 2",
      "description": "This is`example 2`"
    }
  }

"examples": {
   "1": {
     "value": {
       "name": "Blake Keeling",
       "id": "165061",
       "email": "Blake.Keeling@gmail.com"
     },
     "summary": "example1",
     "description": "This is`example 1`"
   },
    "2": {
      "value": {
       "name": "Jolie Kutch",
       "id": "138164",
       "email": "Jolie_Kutch@hotmail.com"
     },
     "summary": "example 2",
     "description": "This is`example 2`"
   }
 }

OAS Extensions

Anda dapat menambahkan ekstensi OpenAPI Specification (OAS) kustom ke contoh.

Konfigurasi: Masukkan pasangan key-value JSON di bidang OAS Extension.

{
  "x-demo": true,
  "x-scenario": "error_case"
}

Efek Ekspor: Ekstensi OAS kustom akan dipertahankan sepenuhnya dan disertakan dalam spesifikasi OpenAPI yang diekspor.

"examples": {
    "example1": {
      "x-demo": true,
      "x-scenario": "error_case",
      "value": {
         "name": "Blake Keeling",
         "id": "165061",
         "email": "Blake.Keeling@gmail.com"
      },
      "summary": "example1",
      "description": "This is`example 1`"
    }
}

FAQ

Bagaimana Cara Mengaktifkan Beberapa Contoh Body Permintaan di Proyek Lama?

Tidak diperlukan tindakan manual! Saat Anda menambahkan contoh body permintaan kedua ke endpoint yang sudah ada, sistem secara otomatis meningkatkan format untuk mendukung beberapa contoh.

Bagaimana Cara Menangani Beberapa Contoh Body Permintaan Saat Mengekspor OAS?

Apakah Urutan Contoh Body Permintaan Akan Berubah dalam OAS yang Diekspor?

Bagaimana Cara Membuat Nama Contoh yang Diekspor Lebih Mudah Dipahami?

Mengonfigurasi Beberapa Contoh Body Permintaan

Mengonfigurasi Beberapa Contoh Body Permintaan#

Mengekstrak Parameter Permintaan sebagai Contoh#

Skenario Penggunaan#

Menggunakan Contoh Body Permintaan Selama Debugging#

Tampilan Dokumentasi#

Kepatuhan OAS#

OAS Key#

OAS Extensions#

FAQ#

Mengonfigurasi Beberapa Contoh Body Permintaan

Mengekstrak Parameter Permintaan sebagai Contoh

Skenario Penggunaan

Menggunakan Contoh Body Permintaan Selama Debugging

Tampilan Dokumentasi

Kepatuhan OAS

OAS Key

OAS Extensions

FAQ