如何生成具有所需字段或默认值的 JSON 模式？

Question

我使用杰克逊来处理 JSON 对象，我想要一种方法来从我可以对对象强制执行的类生成模式。 我发现我可以使用这个：

JsonSchemaGenerator generator = new JsonSchemaGenerator(mapper);
JsonSchema jsonSchema = generator.generateSchema(DBUser.class);
mapper.writeValueAsString(jsonSchema);

使用这个 com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator。
从这个类生成：

public class DBUser {

    private String database="stu";
    private int role;
    private String username;
    private String password;
    //setters and getters defined
    }

这给了我这个：

{
  "type" : "object",
  "id" : "urn:jsonschema:DBUser",
  "properties" : {
    "database" : {
      "type" : "string"
    },
    "role" : {
      "type" : "integer"
    },
    "username" : {
      "type" : "string"
    },
    "password" : {
      "type" : "string"
    }
  }
}

我需要的是这样的必填字段：

"required": ["database","role","username"]

但它没有我需要的必填字段或初始值。 那我怎么能得到呢？

Answer 1

您可以使用JsonProperty#required设置为true来注释您的 pojo DBUser类字段，以生成带有必填字段的 jsonschema：

public class DBUser {

    @JsonProperty(required = true)
    private String database = "stu";
    @JsonProperty(required = true)
    private int role;
    @JsonProperty(required = true)
    private String username;
    private String password;
}

//generate the new jsonschema with the required fields
JsonSchemaGenerator generator = new JsonSchemaGenerator(mapper);
JsonSchema jsonSchema = generator.generateSchema(DBUser.class);
System.out.println(mapper.writerWithDefaultPrettyPrinter()
                         .writeValueAsString(jsonSchema));


//json generated
{
  "type" : "object",
  "id" : "urn:jsonschema:DBUser",
  "properties" : {
    "database" : {
      "type" : "string",
      "required" : true
    },
    "role" : {
      "type" : "integer",
      "required" : true
    },
    "username" : {
      "type" : "string",
      "required" : true
    },
    "password" : {
      "type" : "string"
    }
  }
}

请注意，根据文档，jsonschema 模块支持创建 JSON Schema (v3) 而不是更高的 JSON Schema 版本，因此不支持更高版本中引入的关键字。