Discriminator の使用

特定のシナリオでは、1 つのオブジェクトが複数の構造形式を持つ場合があります。たとえば、書籍は eBook またはペーパーバックのいずれかである可能性があります。このような場合、discriminator フィールドを使用して、異なるスキーマタイプを区別できます。

discriminator は通常、oneOf または anyOf と組み合わせて使用され、「特定のフィールドの値によってオブジェクトの具体的なタイプが決定される」ことを示します。

プロパティ	説明
propertyName	タイプを区別するために使用するフィールド名を指定します。
mapping	フィールド値と対応するスキーマの間のマッピングを定義します。

Apidog での設定

方法 1: JSON Schema を使用する

ビジュアルインターフェースで oneOf を設定する

API のリクエストまたはレスポンスエディターを開きます。「Schema Composition」フィールドとして定義したいフィールドを選択します。Advanced Settings > Schema Composition > oneOf をクリックし、eBook や Paperback など、oneOf で組み合わせたいスキーマを参照します。