Swagger:是否可以使操作参数恒定/只读?

时间:2014-09-25 13:04:50

标签: swagger

这是我所拥有的某个参数的描述:

{
    "name": "myParam",
    "description": "My param description",
    "required": true,
    "paramType": "query",
    "type": "string",
    "defaultValue":"myValue"
}

defaultValue是参数可以拥有的唯一值,所以有没有办法声明这个?在swagger-ui的上下文中,我需要参数的文本框是只读的。我使用了swagger 1.2。

由于

1 个答案:

答案 0 :(得分:13)

宣布这个的正确方法是:

{
    "name": "myParam",
    "description": "My param description",
    "required": true,
    "paramType": "query",
    "type": "string",
    "enum": [ "myValue" ]
}

" enum" property设置可能的值。一旦您为其设置了单个值,那就是唯一可以使用的值,并且可以在UI中使用,供用户选择。