javascript - 在 Swagger 中支持复杂对象

Question

我们将非常感谢您对此的帮助。

我正在使用 json 和 swagger 版本 2.0.39。 如果我的休息服务需要像下面这样的动态复杂数组

eg:- 
addressList:[
{
lane:abc
city:colombo
},
{
lane:def
city:colarado
}
]

addressList 可以包含一个或多个(动态)地址

如何编写我的 swagger 文件来支持这种结构。如果我使用 swagger UI，它将如何填充。 我认为应该有一个预定义的 Swagger 方式来支持这样的事情。不是吗？ 我尝试了各种替代方案，唯一的选择是定制，我认为这对我来说不是一件容易的事。

我们将非常感谢您的帮助。 谢谢。

Answer 1

Swagger 确实支持此功能。您需要在模型中定义类似于以下内容的 addressList 字段:

"addressList":{
    "type":"array",
    "items":{
         "$ref": "#/definitions/dynamic_addresses",
     }
 }

其中#/definitions/dynamic_addresses引用了一个模型，该模型描述了addressList数组中的动态地址模型。

看看Swagger Docs了解有关 Swagger 模型规范和嵌套定义的更多信息。