Menggunakan Discriminator

Dalam skenario tertentu, satu objek dapat memiliki beberapa bentuk struktural. Misalnya, sebuah buku dapat berupa eBook atau buku paperback. Dalam kasus seperti ini, field discriminator dapat digunakan untuk membedakan berbagai tipe schema.

discriminator biasanya digunakan bersama dengan oneOf atau anyOf untuk menunjukkan bahwa "nilai dari field tertentu menentukan tipe konkret dari objek".

Properti	Deskripsi
propertyName	Menentukan nama field yang digunakan untuk membedakan tipe.
mapping	Mendefinisikan pemetaan antara nilai field dan schema yang sesuai.

Mengonfigurasi di Apidog

Metode 1: Menggunakan JSON Schema

Mengonfigurasi oneOf melalui Antarmuka Visual

Buka editor permintaan atau respons API. Pilih field yang ingin Anda definisikan sebagai field "Schema Composition". Klik Advanced Settings > Schema Composition > oneOf, lalu referensikan schema yang ingin Anda gabungkan dalam oneOf, seperti eBook dan Paperback.

Menambahkan discriminator melalui JSON Schema

Klik JSON Schema di editor untuk beralih ke mode kode.

Tambahkan konfigurasi discriminator, misalnya:

Ganti 10331225 dan 10331226 dengan ID schema aktual Anda. Anda dapat melihat ID ini saat membuka panel konfigurasi JSON Schema.

Memverifikasi Hasil

Setelah disimpan, Apidog akan secara otomatis mengenali berbagai tipe berdasarkan field type. Saat Anda Publish Docs, dokumentasi API akan menampilkan tipe yang dibedakan dengan benar.

Discriminator dalam dokumentasi yang dipublikasikan

Metode 2: Mengimpor File OpenAPI

Tulis definisi ke dalam file OpenAPI YAML atau JSON, misalnya:

Contoh definisi lengkap:

Kemudian, di Apidog, pilih Import OpenAPI File.

Setelah diimpor, Apidog akan secara otomatis mengenali discriminator dan memetakan tipe dengan benar dalam definisi schema dan endpoint. Saat Anda Publish Docs, dokumentasi API akan menampilkan tipe yang dibedakan dengan benar.

Menggunakan Discriminator

Mengonfigurasi di Apidog#

Metode 1: Menggunakan JSON Schema#

Metode 2: Mengimpor File OpenAPI#

Mengonfigurasi di Apidog

Metode 1: Menggunakan JSON Schema

Metode 2: Mengimpor File OpenAPI