識別器（Discriminator）の利用方法

特定のケースにおいて、1つのオブジェクトが複数の構造を持つ場合があります。例えば、本は「eBook」と「ペーパーバック」のいずれかの形式で存在し得ます。このような場合、discriminatorフィールドを活用することで、異なるSchemaタイプを区別できます。

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

propertyName：型を区別するために使用するフィールド名を指定します。

mapping：フィールド値と対応するSchemaとのマッピングを定義します。

Apidogでの設定方法

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

APIのリクエストまたはレスポンスエディタを開きます。「組合せモード」として定義したいフィールドを選択します。高度な設定 → 組合せモード → oneOfをクリックし、oneOfに組み合わせたいschema（例：eBookやPaperback）を指定します。

JSON Schemaでdiscriminatorを追加

エディタ内でJSON Schemaをクリックし、コードモードに切り替えます。

discriminatorの設定を追加します。例：

10331225や10331226は、ご自身のschemaのIDに置き換えてください。これらのIDは、JSON Schema設定パネルを開いた際に確認できます。

結果の確認

保存後、Apidogはtypeフィールドの値に基づいて自動的に各タイプを判別します。ドキュメント公開時には、APIドキュメント上で正しく区別されたタイプが表示されます。

OpenAPI仕様書（YAMLまたはJSONファイル）に定義を記述します。例：

全体の定義例：

その後、ApidogでOpenAPIファイルをインポートを選択します。

インポート後、Apidogはdiscriminatorを自動的に認識し、schemaやAPI定義内で型を正しくマッピングします。ドキュメント公開時には、APIドキュメント上で区別されたタイプが正しく表示されます。