Как определить пустой массив в swagger

Я знаю, как сделать массив строковых данных в swagger следующим образом:

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

он покажет вывод следующим образом:

"photoUrls":[
    "string"
]

как сделать вывод такой?:

"photoUrls":[]

2 ответов


вы не знаете. Идея в том, что

"photoUrls":[
    "string"
]

показывает пользователям, что photoUrls - это массив строк. В противном случае они не смогут узнать, какой тип данных используется массивом.


вы можете указать пустой массив [] как example для схемы массиве. Это переопределит значения примеров по умолчанию, созданные Swagger UI.

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

но Рон является более удобным для пользователей. Рассмотрим использование некоторого реального мира example значения вместо:

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