在 Swagger 中支持复杂对象
Supporting Complex Objects in Swagger
非常感谢您在这方面的帮助。
我正在使用 json 和 swagger 版本 2.0.39。
如果我的休息服务需要像下面这样的动态复杂数组
eg:-
addressList:[
{
lane:abc
city:colombo
},
{
lane:def
city:colarado
}
]
地址列表可以包含一个或多个(动态)地址
如何编写我的 swagger 文件来支持这种结构。如果我使用 swagger UI,它将如何填充。
我认为应该有一个预定义的招摇方式来支持这样的事情。不是吗?
我尝试了各种替代方案,唯一的选择是自定义,我认为这对我来说不是一件容易的事。
非常感谢您的帮助。
谢谢。
Swagger 支持此功能。您需要在您的模型中定义 addressList 字段,类似于:
"addressList":{
"type":"array",
"items":{
"$ref": "#/definitions/dynamic_addresses",
}
}
其中 #/definitions/dynamic_addresses
引用了一个模型,该模型描述了 addressList 数组中的动态地址模型。
查看 Swagger Docs 以了解有关 Swagger 模型规范和嵌套定义的更多信息。
非常感谢您在这方面的帮助。
我正在使用 json 和 swagger 版本 2.0.39。 如果我的休息服务需要像下面这样的动态复杂数组
eg:-
addressList:[
{
lane:abc
city:colombo
},
{
lane:def
city:colarado
}
]
地址列表可以包含一个或多个(动态)地址
如何编写我的 swagger 文件来支持这种结构。如果我使用 swagger UI,它将如何填充。 我认为应该有一个预定义的招摇方式来支持这样的事情。不是吗? 我尝试了各种替代方案,唯一的选择是自定义,我认为这对我来说不是一件容易的事。
非常感谢您的帮助。 谢谢。
Swagger 支持此功能。您需要在您的模型中定义 addressList 字段,类似于:
"addressList":{
"type":"array",
"items":{
"$ref": "#/definitions/dynamic_addresses",
}
}
其中 #/definitions/dynamic_addresses
引用了一个模型,该模型描述了 addressList 数组中的动态地址模型。
查看 Swagger Docs 以了解有关 Swagger 模型规范和嵌套定义的更多信息。