如何确保 NJsonSchema 只包含必填字段？

Question

我正在使用 NJsonSchema v2.6 为以下 class 生成 JSON 架构：

[DataContract(Name = "Message", Namespace = "")]
public class AMessageModel
{
    [DataMember]
    internal Guid MessageId { get; set; }

    internal DateTime MessageDate { get; set; }
}

[DataContract(Name = "Message", Namespace = "")]
public class AddUserMessage : AMessageModel
{
    [DataMember]
    public string AccountName { get; set; }

    [DataMember]
    public string FistName { get; set; }

    [Range(2, 5)]
    [DataMember]
    public string LastName { get; set; }

    [DataMember]
    public string Email { get; set; }

    [DataMember]
    public string Password { get; set; }
}

生成的JSON架构：

        {
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "object",
          "typeName": "AddFitnessHubAccountMessage",
          "additionalProperties": false,
          "properties": {
            "AccountName": {
              "type": [
                "null",
                "string"
              ]
            },
            "FistName": {
              "type": [
                "null",
                "string"
              ]
            },
            "LastName": {
              "type": [
                "null",
                "string"
              ]
            },
            "Email": {
              "type": [
                "null",
                "string"
              ]
            },
            "Password": {
              "type": [
                "null",
                "string"
              ]
            }
          },
          "allOf": [
            {
              "type": "object",
              "typeName": "AMessageModel",
              "additionalProperties": false,
              "properties": {
                "MessageId": {
                  "type": "string",
                  "format": "guid"
                },
                "MessageDate": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          ]
        }

即使 MessageDate 属性未标记为 DataMember，它始终包含在模式中，而且生成的模式包含两个模式路径，而它应该只包含一个，似乎解析器是不展平属性。

更新

这解决了创建多个架构路径的问题

new JsonSchemaGeneratorSettings
{
    FlattenInheritanceHierarchy = true
}

GitHub 问题：https://github.com/NJsonSchema/NJsonSchema/issues/53

Answer 1

由于 NJsonSchema 依赖于 Newtonsoft.Json，您是否从 Newtonsoft.Json 文档中尝试过？

Conditional Property Serialization

To conditionally serialize a property, add a method that returns boolean with the same name as the property and then prefix the method name with ShouldSerialize. The result of the method determines whether the property is serialized. If the method returns true then the property will be serialized, if it returns false then the property will be skipped.

Answer 2

我是库的作者 NJsonSchema。

忽略的属性

库中有一个错误，现在 (v2.7+) 属性忽略工作如下：

A property is ignored when either

The property is marked with the JsonIgnoreAttribute property

The class has an DataContractAttribute attribute and the property has no DataMemberAttribute and no JsonPropertyAttribute

https://github.com/NJsonSchema/NJsonSchema/wiki/JsonSchemaGenerator

扁平化继承层次结构

正如您已经发现的，您可以通过 FlattenInheritanceHierarchy 设置展平继承层次...

库主要用于代码生成，因此通常需要继承。

如何确保 NJsonSchema 只包含必填字段？

How to make sure that NJsonSchema only includes required fields?

c#

njsonschema