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

Question

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

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

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

谢谢

Answer 1

声明这个的正确方法是:

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

"enum"属性设置可能的值.一旦为其设置了单个值,那么这是唯一可以使用的值,并且可以在UI中供用户选择.