通过Swagger/OpenAPI为additionalProperties指定多种类型

Question

我希望在OpenAPI中表示以下JSON对象：

{
  "name": "Bob",
  "age": 4,
  ...
}

属性的数量和属性名称不是完全预先确定的，所以我希望使用additionalProperties。然而，我不太确定它将如何通过OpenAPI/Swagger 2.0来表示。我试过这个：

Person:
  type: object
  additionalProperties:
    type:
      - int
      - string

或JSON等价物：

{
  "Person": {
    "type": "object",
    "additionalProperties": {
      "type": ["int", "string"]
    }
  }
}

但这不太管用。有没有办法保持我想要表示的JSON对象的结构，特别是字符串和整数，而不是任意对象类型？

Answer 1

OpenAPI 3支持oneOf，因此您可以使用：

Person:
  type: object
  additionalProperties:
    oneOf:
      - type: string
      - type: integer

OpenAPI 2.0不支持多类型值。您最多只能使用无类型模式，这意味着附加属性可以是任何内容——字符串、数字、布尔值等等——但您无法指定确切的类型。

Person:
  type: object
  additionalProperties: {}

这相当于：

Person:
  type: object