Uso de Discriminator

En ciertos escenarios, un único objeto puede tener múltiples formas estructurales. Por ejemplo, un libro puede ser un eBook o una edición de bolsillo. En estos casos, el campo discriminator puede utilizarse para distinguir entre diferentes tipos de esquema.

El discriminator suele utilizarse en combinación con oneOf o anyOf para indicar que "el valor de un campo específico determina el tipo concreto del objeto".

Propiedad	Descripción
propertyName	Especifica el nombre del campo utilizado para diferenciar tipos.
mapping	Define la asignación entre los valores de campo y los esquemas correspondientes.

Configuración en Apidog

Método 1: Uso de JSON Schema

Configurar oneOf mediante la interfaz visual

Abra el editor de petición o respuesta de la API. Seleccione el campo que desea definir como un campo de "Composición de esquema". Haga clic en Configuración avanzada > Composición de esquema > oneOf, y haga referencia al esquema que desea combinar en oneOf, como eBook y Paperback.

Agregar discriminator mediante JSON Schema

Haga clic en JSON Schema en el editor para cambiar al modo de código.

Agregue la configuración de discriminator, por ejemplo:

Reemplace 10331225 y 10331226 por los ID de su esquema real. Puede ver estos ID al abrir el panel de configuración de JSON Schema.

ID de esquema en el panel de JSON Schema

Verificar el resultado

Después de guardar, Apidog reconocerá automáticamente diferentes tipos en función del campo type. Cuando publique la documentación, la documentación de la API mostrará correctamente los tipos diferenciados.

Discriminator en la documentación publicada

Método 2: Importación de archivo OpenAPI

Escriba la definición en un archivo OpenAPI YAML o JSON, por ejemplo:

Ejemplo de definición completa:

Luego, en Apidog, elija Importar archivo OpenAPI.

Después de importar, Apidog reconocerá automáticamente el discriminator y asignará correctamente los tipos en las definiciones de esquema y endpoint. Cuando publique la documentación, la documentación de la API mostrará correctamente los tipos diferenciados.

Configuración en Apidog#

Método 1: Uso de JSON Schema#

Método 2: Importación de archivo OpenAPI#

Configuración en Apidog

Método 1: Uso de JSON Schema

Método 2: Importación de archivo OpenAPI