如何在swagger中定义空数组

smf*_*ftr 11 swagger swagger-ui

我知道如何在swagger中制作字符串数据数组,如下所示:

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string"
    }
}
Run Code Online (Sandbox Code Playgroud)

它将显示如下输出:

"photoUrls":[
    "string"
]
Run Code Online (Sandbox Code Playgroud)

如何制作这样的输出?:

"photoUrls":[]
Run Code Online (Sandbox Code Playgroud)

Hel*_*len 10

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

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string"
    },
    "example": []
}
Run Code Online (Sandbox Code Playgroud)

但是罗恩的答案对您的用户来说更加用户友好。考虑改用一些实际example值:

"photoUrls" : {
    "type":"array",
    "items":{
         "type":"string",
         "example": "http://example.com/images/pet.png"
    },
}
Run Code Online (Sandbox Code Playgroud)


Ron*_*Ron 6

你没有.这个想法就是这样

"photoUrls":[
    "string"
]
Run Code Online (Sandbox Code Playgroud)

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

  • 他们会,在 JSON 中,空数组是 [],swagger 应该返回空数组而不是 null (2认同)