json - OpenApi - 如何指定具有未知属性名称的响应 json

Question

我有一个 API 可以根据请求返回数据行。这些行是包含名称:值对的 JSON 元素。但是，属性名称(和值的数据类型)需要在规范中是可变的和未定义的。

例如:

{
    "row_id": 1234,
    "data": {
        "foo": "bar",
        "date": "2019-07-31",
        "some_number": 5
    }
 }

在这个例子中，属性“row_id”和“data”是唯一固定的东西。 data 元素中的所有名称:值对可以是任何内容。

我相信我可以使用开放式 API additionalProperties 来描述这一点，但我找不到任何示例告诉我如何或确认这是正确的。

有没有人知道如何执行此操作或可以指出正确的方向？

Answer 1

看起来我要找的是:

    recordData:
      type: object
      additionalProperties: {}

type: object 将其定义为一般对象，additionalProperties: {} 表示该对象包含未具体定义的属性。

我最终找到的文档还说 additionalProperties: true 也可以。