Saltar al contenido principal
Cuando tu API admite múltiples formatos de datos, tiene campos condicionales o usa patrones de herencia, las palabras clave de composición de esquemas de OpenAPI te ayudan a documentar estas estructuras flexibles. Con oneOf, anyOf y allOf, puedes describir APIs que aceptan distintos tipos de entrada o combinan múltiples esquemas en modelos de datos integrales.

​
Palabras clave oneOf, anyOf, allOf

Para tipos de datos complejos, OpenAPI proporciona palabras clave para combinar esquemas:
  • allOf: Combina varios esquemas (como fusionar objetos o extender un esquema base). Funciona como un operador and.
  • anyOf: Acepta datos que coincidan con cualquiera de los esquemas proporcionados. Funciona como un operador or.
  • oneOf: Acepta datos que coincidan exactamente con uno de los esquemas proporcionados. Funciona como un operador exclusive-or.
Mintlify trata oneOf y anyOf de forma idéntica, ya que la diferencia práctica rara vez afecta el uso de la API.
Para obtener especificaciones detalladas de estas palabras clave, consulta la documentación de OpenAPI.
La palabra clave not no es compatible actualmente.

​
Combinando esquemas con allOf

Cuando usas allOf, Mintlify realiza un preprocesamiento de tu documento de OpenAPI para mostrar combinaciones complejas de forma legible. Por ejemplo, cuando combinas dos esquemas de objeto con allOf, Mintlify unifica las propiedades de ambos en un solo objeto. Esto resulta especialmente útil al aprovechar los componentes reutilizables de OpenAPI. 
org_with_users:
  allOf:
    - $ref: '#/components/schemas/Org'
    - type: object
      properties:
        users:
          type: array
          description: Una matriz que contiene todos los usuarios de la organización
# ...
components:
  schemas:
    Org:
      type: object
      properties:
        id:
          type: string
          description: El ID de la organización
​
org_with_users
object

​
Proporcionar opciones con oneOf y anyOf

Cuando uses oneOf o anyOf, las opciones se muestran en un contenedor con pestañas. Especifica un campo title en cada subschema para poner nombre a tus opciones. Por ejemplo, así podrías mostrar dos tipos distintos de direcciones de entrega: 
delivery_address:
  oneOf:
    - title: StreetAddress
      type: object
      properties:
        address_line_1:
          type: string
          description: La dirección postal del destinatario
        # ...
    - title: POBox
      type: object
      properties:
        box_number:
          type: string
          description: El número del apartado de correos
        # ...
​
delivery_address
object
  • StreetAddress
  • POBox
​
address_line_1
string
La dirección de la residencia