如何创建摇摆数组

Question

我试图为下面的JSON创建一个swagger文档，但是我得到了下面的错误:带有“type: array”的模式需要一个同级“items:”字段

JSON：

{
    "_id": "string",
    "name": "string",
    "descriptions": {},
    "date": "string",
    "customer": {
        "id": "string",
        "name": {
            "firstName": "string",
            "lastName": "string",
            "middleName": "string"
        }
    },
    "productDetials": {
        "id": "string",
        "name": {
            "name": "string",
            "model": "string",
            "price": "string",
            "comments": "string"
        }
    },
    "Phone": [{
            "id": "string",
            "category": "string",
            "version": "string",
            "condition": "string",
            "availability": "string"

        }
    ]   
}

有人能帮我得到这个JSON的招摇博士。

任何帮助都将不胜感激。

Answer 1

首先，你必须定义依赖于JSON(对象)的模型。

对于您的情况:

• 订单（我猜）
• 客户
• 客户名称
• 产品详情
• 产品名称
• 电话

然后在YAML（Swagger模式文档）的定义部分中定义模型：

Order:
  type: "object"
  properties:
    _id:
      type: "string"
    name:
      type: "string"
    descriptions:
      type: "object"
    date:
      type: "string"
    customer:
      $ref: "#/definitions/Customer"
    productDetails:
      $ref: "#/definitions/ProductDetails"
    phoneNumbers:
      type: "array"
      items:
        $ref: "#/definitions/Phone"
Customer:
  type: "object"
  properties:
    id:
      type: "string"
    name:
      $ref: "#/definitions/CustomerName"
CustomerName:       
  type: "object"
  properties:
    firstName:
      type: "string"
    lastName:
      type: "string"
    middleName:
      type: "string"
ProductDetails:
  type: "object"
  properties:
    id:
      type: "string"
    name:
      $ref: "#/definitions/ProductName"
ProductName:       
  type: "object"
  properties:
    name:
      type: "string"
    model:
      type: "string"
    price:
      type: "string"
    comments:
      type: "string"
Phone:
  type: "object"
  properties:
    id: 
      type: "string"
    category:
      type: "string"
    version:
      type: "string"
    condition:
      type: "string"
    availability:
      type: "string"

如果您想要将具有特定模型的数组定义为项目-将< code>array作为< code>type并定义< code>items(根据您忘记的提供的错误代码)。< code>items是数组的内容，因此< code>Phone模型:

...
phoneNumbers:
  type: "array"
  items:
    $ref: "#/definitions/Phone"