Question

Tech＆amp;版本：

Swagger 2.0（使用json，而不是yaml）
JSON.NET架构（Newtonsoft.Json：10.0.0.2，Newtonsoft.Json.Schema：3.0.4）

要求：

＆＃34;深层嵌套引用＆＃34;与Swagger。作为最终结果，我想要一个主要的swagger文件，$ ref一个外部文件用于路径参数/响应定义，然后外部文件应该能够$ ref在同一个文件中的子定义。

到目前为止：

我正在使用JSON.NET Schema库来运行我们的程序集并以json格式创建swagger模式。然后从我们的主swagger.json文件手动引用它们。我有2个结果：

生成外部文件WITHOUT $ ref definitions，all inline，然后当我从swagger.json中获取外部文件时，一切都很顺利天堂。
使用$ ref定义生成外部文件，然后在I $ ref时生成来自swagger.json的外部文件，然后没有$ ref中的外部文件可以解决。

我想让结果2正常工作。

例如，如果我有以下两个文件，我想要＆＃34; $ ref＆＃34;：＆＃34;＃/ definitions / Education＆＃34;部分工作。 swaggerSchemas.json输出是我从JSON.NET Schema生成器获得的。我试过移动＆＃34;定义＆＃34;出于＆＃34;人＆＃34;到swaggerSchemas.json的根json包装，但这也不起作用。当我说＆＃34;它不起作用时，我的意思是Swagger并不喜欢它。应用程序死于Swagger验证错误。

swagger.json

{
    "swagger": "2.0",
    "info": {
        "version": "0.0.1",
        "title": "ASDF"
    },
    "basePath": "/",
    "schemes": [
        "http",
        "https"
    ],
    "consumes": [
        "application/json",
        "application/octet-stream"
    ],
    "produces": [
        "application/json"
    ],
    "paths": {
        "/person": {
            "x-swagger-router-controller": "PersonController",
            "get": {
                "x-function": "find",
                "description": "Default Description",
                "tags": [
                    "gen"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                        "schema": {
                            "$ref": "swaggerSchemas.json#/Person"
                        }
                    },
                    "default": {
                        "$ref": "#/responses/ErrorResponse"
                    }
                }
            }
        }
    }
}

swaggerSchemas.json

{
    "Person": {
        "definitions": {
            "education": {
                "type": "object",
                "properties": {
                  "highestQualification": {
                    "type": "string"
                  },
                  "extraData": {
                    "type": [
                      "string",
                      "number",
                      "integer",
                      "boolean",
                      "object",
                      "array"
                    ]
                  }
                },
                "required": [
                  "highestQualification",
                  "extraData"
                ]
            }
        },
        "type": "object",
        "properties": {
            "userId": {
                "type": "string"
            },
            "firstNames": {
                "type": "string"
            },
            "surname": {
                "type": "string"
            },
            "education": {
                "$ref": "#/definitions/Education"
            }
        }
    }
}

这是一种行为，即＆＃34;深嵌套$ ref＆＃34;适用于Swagger 2.0？

如果是这样，我如何在JSON.NET Schema中完成此任务？

Answer 1

swaggerSchemas.json文件的结构看起来不合适：

Before

包含多个模式的文件应如下所示。根标记名称可以是任意的，但通常使用{ "Person": { "definitions": { "education": { "type": "object", ... } }, "type": "object", ... } }。

definitions

此外，在主文件中，更改

{
  "definitions": {

    // "Education", not "education".
    // The letter case of the schema name must be the same as used in the $ref below.
    "Education": {
      "type": "object",
      ...
    },

    "Person": {
      "type": "object",
      "properties": {
        ...,
        "education": {
          "$ref": "#/definitions/Education"
        }
      }
    }

  }
}

到

"$ref": "swaggerSchemas.json#/Person"

反映swaggerSchemas.json文件中的新节点结构（"$ref": "swaggerSchemas.json#/definitions/Person" - ＆gt; definitions）。

使用URI

1 个答案: