Swagger-如何定义多维数组

时间:2019-01-22 11:59:49

标签: multidimensional-array swagger

我找不到任何示例。也许是因为缺乏我的Swagger知识,或者也许没有类似的例子。

是否可以在暴露类型为多维数组的情况下写一个大胆的定义?

1 个答案:

答案 0 :(得分:1)

由于swagger使用Json Schema来建模通过API公开的类型,因此您确实需要知道如何在Json Schema中建模多维(Nd)数组。

答案是:Json Schema中没有对Nd数组的内置支持。

但是,json模式确实支持arrays,并且没有什么可以阻止数组中的项本身就是数组。因此,您可以仅使用数组数组来定义Nd数组。

"2dArrayOfInt": {
  "type": "array",
  "items": {
    "type": "array",
    "items": {
      "type": "integer" // This will be a 2d array of numbers
      ...
    }
  }
}

不好,但是Nd数组都不是。