如何定义模式任意JSON对象？

Question

我正在尝试使用OAS v2定义一个API，它将返回一个有效负载以及一些元数据。

换句话说，对API的响应将是：

{
  "metadata":[
   {
     "key" :"key1",
     "value": "value1"
   }
  ],
  "payload": {Valid JSON}
}

有效负载可以是任何内容，并且在不同的场景下会有所不同，唯一的限制是它将是有效的JSON格式。因此，现在，我想将其定义为一个JSON对象，而不定义字段级别的细节。

如何在OAS2/JSON模式中做到这一点？

提前谢谢。

Answer 1

在这种情况下，可以使用空模式（{}）作为有效负载。

JSON模式依赖于有效的JSON值，如果您的响应是格式错误的JSON，则无法提供该值。

如果有效负载值格式错误，则整个响应将不是有效的JSON。

换句话说，这个问题不在JSON模式范围内，而是在响应解码器的范围内（在格式错误的响应体上应该失败）。