如何在swagger规范中定义两个属性中的任何一个都不是null并且是必需的

Question

我要求在有效负载中有两个属性，比如属性1和属性2。两者都是数组类型。条件是，要么两者都可以有值，要么其中只有一个为非空。但两者不能同时为空。我如何在swagger规范中定义这个需求，这样我就可以实施模式，使得两者都不应该为空，但是其中任何一个都可以为空。

有效示例：

Ex1--> {"Property1": ["value1"], "Property2": ["value2"]}  
Ex2--> {"Property2": ["value2"]} 
Ex3--> {"Property1": ["value1"]}

无效示例：

{"Property1": [], "Property2": []}

Answer 1

假设对象只能包含这两个属性（Property1和/或Property2），而没有其他属性，则可以使用对象级 和数组级 minItems

MyObject:
  type: object
  minProperties: 1  # <-- requires at least one of Property1 or Property2 to be present
  properties:
    Property1:
      type: array
      items:
        type: string
      minItems: 1   # <-----
    Property2:
      type: array
      items:
        type: string
      minItems: 1   # <-----

如果有效载荷还可以包含其他属性，则可以使用anyOf所需定义“ 或

# openapi: 3.x.x

MyObject:
  type: object
  anyOf:   # <----------------
    - required: [Property1]
    - required: [Property2]
  properties:
    Property1:
      type: array
      items:
        type: string
      minItems: 1
    Property2:
      type: array
      items:
        type: string
      minItems: 1
    SomeOtherProperty:
      ...