swagger OpenAPI查询参数描述未设置为文本框作为占位符

yeotifhr  于 2023-10-18  发布在  其他
关注(0)|答案(2)|浏览(150)

我已经使用描述来添加查询参数的详细信息,

"parameters": [                 
                {
                    "name": "role",
                    "in": "query",
                    "required": true,
                    "schema": {
                        "type": "string"
                    },
                    "description": "This is test description to reproduce placeholder not fit to textbox"                       
                }]

当我加载openapi.json以swagger时,它显示描述以及文本框占位符。有没有办法为占位符添加单独的文本,或者有没有办法修复占位符中显示所有文本的问题?这里的文字被剥离

vwoqyblh

vwoqyblh1#

如果参数有exampledefault值(或OpenAPI 2.0中的x-example),Swagger UI将使用此值作为占位符。

否则,正如您所注意到的,占位符文本将与参数的description相同。
有一个现有的功能请求删除或改进默认的占位符文本:
https://github.com/swagger-api/swagger-ui/issues/3920

ttisahbt

ttisahbt2#

你总是可以覆盖auto-openapi库中的方法。代替defaultkey,您可以使用placeholder属性来避免与验证器的模式冲突。在MoleculerJS的情况下,你可以这样做:
1.调用方法getTypeAndExample,增加一个键占位符的条件检查。if (node.placeholder) { out.example = node.placeholder; }
1.它可能需要某些枚举,从库中粘贴或从下面复制,const NODE_TYPES = { boolean: "boolean", number: "number", date: "date", uuid: "uuid", email: "email", url: "url", string: "string", enum: "enum", }
1.在模式的prop中使用placeholder:"<value>",只填充要在swagger UI中尝试的值。

相关问题