在Swagger中支持复杂对象

时间:2015-12-15 06:08:28

标签: javascript rest swagger swagger-ui

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

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

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

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

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

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

1 个答案:

答案 0 :(得分:2)

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

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

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

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