如何用swagger描述复杂json模型

Question

我试图用Swagger来描述我正在构建的web-api。问题是我无法理解如何描述复杂的json对象？

比如如何描述这个对象：

{
  name: "Jhon",
  address: [
    {
      type: "home",
      line1: "1st street"
    },
    {
       type: "office",
       line1: "2nd street"
    }
  ]
}

Answer 1

好的，根据上面的注释，您需要以下模式：

{
  "definitions": {
    "user": {
      "type": "object",
      "required": [ "name" ],
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/address"
          }
        }
      }
    },
    "address": {
        "type": "object",
        "properties": {
            "type": {
                "type": "string",
                "enum": [ "home", "office" ]
            },
            "line1": {
                "type": "string"
            }
        }
    }
  }
}

我做了一些假设，使示例变得更复杂一些，以便将来有所帮助。对于“user”对象，我声明“name”字段是必需的。例如，如果您还需要地址是强制性的，则可以将定义更改为“required”:[“name”，“address”]。

我们基本上使用json-schema的一个子集来描述模型。当然不是每个人都知道它，但它的学习和使用相当简单。

{
  "definitions": {
    "user": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "home",
                  "office"
                ]
              },
              "line1": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}