具有命名元素数组的Swagger模型

Question

对我来说，为json数组编写swagger模型似乎非常简单，例如，如果我有这个数组：

[
  {
    "name": "dave",
    "number": 123
  },
  {
    "name": "mary",
    "number": 456
  }
]

我会为它写以下大摇大摆的模型：

"schema": {
  "type": "array",
  "items": {
    "$ref": "Student"
  }
}

"Student": {
  "id": "Student",
  "required": [
    "name",
    "number"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "number": {
      "type": "integer",
      "format": "int32"
    }
  }
}

然而，我有以下几点：

{
  "123": {
    "name": "dave"
  },
  "456": {
    "name": "mary"
  }
}

我如何为这一个写模型？

提前谢了。

Answer 1

要描述请求模型，需要使用additionalproperties属性。请注意，这在Swagger2.0中是可用的，在早期版本中是不可用的。

"definitions": {
    "Student": {
        "type": "object",
        "required": [ "name" ],
        "properties": {
            "name": {
                "type": "string"
            }
        }
    },
    "Students": {
        "type": "object",
        "additionalProperties": {
            "$ref": "#/definitions/Student"
        }
    }
}

上面您可以看到student模型，该模型目前包含“name”属性，不过我假设您还会向其添加更多内容。从上面的示例来看，“name”属性是必需的。

第二个模型是students，它是一个包含映射（additionalProperties）的对象。每个属性都是student类型（通过引用模型完成，但理论上可以内联定义）。

您不能做的一件事是声明键（或属性名）是整数或给定类型。patternedproperties可以支持这一点，但在Swagger2.0中没有。换句话说，没有限制密钥内容的技术方法。