小编Xav*_*tte的帖子

Swagger:<string,Object>的地图

我需要用Swagger记录一个API,它既用作输入又用于输出和输出的对象映射,用字符串键索引.

例:

{
    "a_property": {
        "foo": {
            "property_1": "a string 1",
            "property_2": "a string 2"
        },
        "bar": {
            "property_1": "a string 3",
            "property_2": "a string 4"
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

"foo"和"bar"可以是任何字符串键,但它们在键集中应该是唯一的.

我知道,使用Swagger,我可以定义一个对象数组,但这会提供一个不同的API,因为我们会有一些东西:

{
    "a_property": [
        {
            "key": "foo"
            "property_1": "a string 1",
            "property_2": "a string 2"
        },
        {
            "key": "bar"
            "property_1": "a string 3",
            "property_2": "a string 4"
        }
    ]
}
Run Code Online (Sandbox Code Playgroud)

我已经阅读了"开放API规范" - "添加对地图数据类型#38的支持"页面.据我所知,它建议使用additionalProperties,但它似乎没有满足我的需要(或者它不适用于我使用的Swagger UI 2.1.4).我错过了什么?

到目前为止,我已经找到了以下解决方法(在Swagger JSON中):

a_property: {
    description: "This is a map that …
Run Code Online (Sandbox Code Playgroud)

dictionary swagger

20
推荐指数
3
解决办法
3万
查看次数

标签 统计

dictionary ×1

swagger ×1