swagger - 如何为 Swagger 中的键未知的键/值建模

Question

我有一个简单的 JSON 对象，它可以包含预先不知道确切值的键/值。它们依赖于一些服务器端进程。我如何在 Swagger 中建模？

JSON 的一个例子是:

... 
,message: "invalid length. Must be in between {min} and {max}" 
,attributes: {
  min: 0
  ,max: 6
}
...

另一个例子是:

... 
,message: "You must fill out this field as well because {field} has a value" 
,attributes: {
  field: "age"
}
...

Answer 1

以下解决方案仅适用于 Swagger 2.0。

像这样定义模型:

{
    "type": "object",
    "properties": {
        "message": {
            "type": "string"
        },
        "attributes": {
            "type": "object",
            "additionalProperties": {}
        }
    }
}

这描述了 attributes作为属性映射，其中的值可以是任何内容(字符串、数字、数组甚至是对象)。