大摇大摆地相互排斥属性

Question

我如何表明在 my_object 中您可以拥有 property_1 或 property_2，但不能同时拥有？

my_object:
  type: object
  properties:
    property_1:
      type: string
    property_2:
      type: string

Answer 1

您可能想切换到 OpenAPI 3.0，它支持 oneOf 关键字来定义互斥条件：

这是一个例子：

 my_object:
 type: object
 properties:
   property_1:
     type: string
   property_2:
    type: integer
 oneOf:
- required: [property_1]
- required: [property_2]

Answer 2

在OpenAPI 3.0 (openapi: 3.0.0) 中，您可以使用oneOf 关键字来定义互斥条件。此架构要求存在 property_1 或 property_2，但不能同时存在：

my_object:
  type: object
  properties:
    property_1:
      type: string
    property_2:
      type: string
    property_3:
      type: string
  oneOf:
    - required: [property_1]
    - required: [property_2]

如果这两个属性中至少有一个必须存在，请改用anyOf。

注意：虽然 oneOf 是 OpenAPI 规范的一部分（如，您可以编写包含 oneOf 的 API 定义），但对 oneOf 的实际工具支持可能会有所不同并受到限制.

如果您使用 OpenAPI 2.0 (swagger: "2.0")，它不支持 oneOf，因此您只能在架构描述或属性描述中口头记录这种情况。