在Swagger 2.0中,数组参数中的“默认”实际上是什么意思?

时间:2018-06-25 15:35:03

标签: json schema swagger

在著名的petstore招摇中,findByStatus端点的状态为:

"parameters": [
    {
        "name": "status",
        "in": "query",
        "description": "Status values that need to be considered for filter",
        "required": true,
        "type": "array",
        "items": {
            "type": "string",
            "enum": [
                "available",
                "pending",
                "sold"
            ],
            "default": "available"
        },
        "collectionFormat": "multi"
    }
]

从此可以隐含默认值,但从程序角度来看,应该将“状态”(以及类似情况下的其他参数)的值视为什么?

  • 该值为数组类型,没有默认值
  • 每个项目都是一个字符串,为可用,待处理或已售中的一个,如果未提供,则默认为“可用”

您如何对任意长度的数组使用“默认”?提供的默认值用于字符串,而不是数组:

  • 这是否意味着该数组没有默认值?
  • 是否暗示该数组的默认值是包含一项的默认值?
  • 这是否意味着一个数组长度的数组,其中所有值都是数组项的默认值?

0 个答案:

没有答案