Newtonsoft.Json.Schema.Generation:人类可读的“定义”部分

时间:2016-05-23 14:15:30

标签: json.net jsonschema

我希望更好地生成和组织定义部分,对我来说这意味着不允许在定义中建立深度,但是,结构树中涉及的每个类应该在定义部分中有自己的条目并通过$引用REF。这意味着对于每个定义,我只会有一个属性列表,这些属性可以是基本类型(字符串,布尔值等),也可以是另一个自定义类的另一个定义条目的$ ref。您还可以将其视为深度1定义,接近最初在C#中定义类的方式。

通过一个简单的例子说明这一点:

            JSchemaGenerator schemaGenerator = new JSchemaGenerator();
            schemaGenerator = new JSchemaGenerator()
            {
                DefaultRequired = Newtonsoft.Json.Required.DisallowNull,
                SchemaIdGenerationHandling = SchemaIdGenerationHandling.TypeName,
                SchemaLocationHandling = SchemaLocationHandling.Definitions,
                SchemaReferenceHandling = SchemaReferenceHandling.Objects,
            };
            JSchema schema = schemaGenerator.Generate(typeof(Setting));

渲染:

{
  "id": "Setting",
  "definitions": {
    "SubSetting": {
      "id": "SubSetting",
      "type": "object",
      "properties": {
        "SubSubSetting": {
          "id": "SubSubSetting",
          "type": "object",
          "properties": {
            "String": {
              "type": "string"
            }
          }
        }
      }
    },
    "SubSubSetting": {
      "$ref": "SubSubSetting"
    }
  },
  "type": "object",
  "properties": {
    "SubSetting": {
      "$ref": "SubSetting"
    },
    "SubSubSetting": {
      "$ref": "SubSubSetting"
    }
  }
}

因此,SubSubSetting定义放在内联SubSetting定义中,稍后我们将SubSubSetting定义为对内联定义的引用。这就是我想要避免的复杂数据结构,它变得非常模糊,我想提供模式,甚至作为基于数据注释和JsonProperty生动,自动生成的文档的一部分。

如何使用JSchemaGenerator完成此操作?

也许我不应该这样做,但作为第二个非常简短的问题:那些$ref在句法上是否正确?它们不应该看起来像"#/definitions/SubSetting"吗?

1 个答案:

答案 0 :(得分:1)

最新版本的Json.NET Schema(3.0.3)已更新以解决此问题。 SubSubSetting将包含完整定义,而不仅仅是$ref

https://github.com/JamesNK/Newtonsoft.Json.Schema/releases/tag/3.0.3