如何在招摇中定义空数组

Question

我知道如何像这样大摇大摆地制作字符串数据数组：

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

它将显示如下输出：

"photoUrls":[
    "string"
]

如何实现这样的输出？:

"photoUrls":[]

Answer 1

你不知道。这个想法是

"photoUrls":[
    "string"
]

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

Answer 2

您可以将空数组 [] 指定为数组架构的 example。这将覆盖 Swagger UI.

生成的默认示例值

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

对您的用户更友好。考虑改用一些真实的 example 值：

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

How to define empty array in swagger