我可以在 swagger 2.0 中定义嵌套数组对象吗

Question

我们将 Swagger 2.0 用于我们的文档。我们正在以编程方式直接从我们的数据设计文档中创建 swagger 2.0 规范。

我们的模型非常复杂且嵌套。我想了解我们能否定义内联定义的嵌套数组对象。

例如：

{
    "definitions": {
        "user": {
            "type": "object",
            "required": ["name"],
            "properties": {
                "name": {
                    "type": "string"
                },
                "address": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "type": {
                                "type": "string",
                                "enum": ["home",
                                "office"]
                            },
                            "line1": {
                                "type": "string"
                            }
                        },
                        "Person": {
                            "type": "object",
                            "properties": {
                                "name": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
} 

我们有很多在模型中遇到这种情况的情况，此时定义#ref 不是我们想要考虑的选项。我们需要这个来内联处理。

根据以下帖子：https://github.com/swagger-api/swagger-editor/issues/603#evenenter code heret-391465196 似乎不支持处理内联定义的嵌套数组对象。

由于许多大企业的数据模型非常复杂，我们希望在 swagger 2.0 规范中支持此功能。

有没有想过要添加这个功能。

Answer 1

您的文档无效，这与嵌套数组无关：items 内的 Swagger 2.0 架构中不允许使用属性 Person。

schema 中唯一允许的属性是：$ref、format、title、description、default、multipleOf、maximum、exclusiveMaximum、@98765433 exclusiveMinimum，maxLength，minLength，pattern，maxItems，minItems，uniqueItems，maxProperties，minProperties，required，enum，additionalProperties，type、items、allOf、properties、discriminator、readOnly、xml、externalDocs、example。