如何在swagger中定义空数组

时间:2015-04-14 10:24:59

标签: swagger swagger-ui

我知道如何以夸张的方式制作字符串数据数组:

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string"
    }
}

它将显示如下输出:

"photoUrls":[
    "string"
]

如何制作这样的输出?:

"photoUrls":[]

2 个答案:

答案 0 :(得分:8)

您可以为数组架构指定一个空数组[]作为example。这将覆盖Swagger UI生成的默认示例值。

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string"
    },
    "example": []
}

Ron's answer对您的用户来说更加用户友好。请考虑使用一些真实的example值:

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string",
         "example": "http://example.com/images/pet.png"
    },
}

答案 1 :(得分:6)

你没有。这个想法是

"photoUrls":[
    "string"
]

向您的用户显示photoUrls是一个字符串数组。否则,他们将无法知道数组使用的数据类型。