将请求查询参数设置为JSON

时间:2018-10-05 14:46:15

标签: yaml openapi swagger-editor

我正在为API编写OpenAPI规范,端点之一是一个GET方法,该方法接收JSON字符串作为查询参数。

我想在参数描述中添加该JSON作为模式,但是当我这样做时,schema关键字随JSON一起提供(例如,在JSON开头,它应该只是第一个属性名称,我拥有改为OrderedMap个字)。另一个示例是在每个列表之前的关键字List

这是我获得的查询参数的示例。运行我的端点示例将不起作用,因为这些关键字未在服务器端进行解析。因此,我想创建一个具有示例值的架构,以根据请求用作查询输入。

OrderedMap { 
    "test": List [ OrderedMap { "id": "1", "key1": 123} ], 
    "test2": "abc"
}

P.S .:我可以做我想做的只是创建一个字符串参数,该示例属性为JSON示例字符串(填充值)。但这是丑陋的IMO

schema:
    type: string
    example: |-
        {
            "test:[{"id":"1","key1":123}],
            "test2":"abc"
        }

0 个答案:

没有答案