oneOf
, anyOf
y allOf
, puedes describir APIs que manejan diferentes tipos de entrada o combinan múltiples esquemas en modelos de datos completos.
Palabras clave oneOf
, anyOf
, allOf
allOf
: Combina varios esquemas (como fusionar objetos o extender un esquema base). Funciona como un operador lógicoand
.anyOf
: Acepta datos que coincidan con cualquiera de los esquemas proporcionados. Funciona como un operador lógicoor
.oneOf
: Acepta datos que coincidan exactamente con uno de los esquemas proporcionados. Funciona como un operador lógicoexclusive-or
.
Mintlify trata
oneOf
y anyOf
de manera idéntica, ya que la diferencia práctica rara vez afecta el uso de la API.La palabra clave
not
no es compatible actualmente.Combinación de esquemas con allOf
allOf
, Mintlify realiza un preprocesamiento en tu documento de OpenAPI para mostrar combinaciones complejas de forma legible. Por ejemplo, cuando combinas dos esquemas de objeto con allOf
, Mintlify fusiona las propiedades de ambos en un único objeto. Esto resulta especialmente útil al aprovechar los componentes reutilizables de OpenAPI.
Proporcionar opciones con oneOf
y anyOf
oneOf
o anyOf
, las opciones se muestran en un contenedor con pestañas. Especifica un campo title
en cada subesquema para asignar nombre a las opciones. Por ejemplo, así podrías mostrar dos tipos de direcciones de entrega: