如何使用所需的提交或默认值生成JSON模式？

Question

我正在使用Jackson处理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＃oilder 设置为true以生成带有必需字段的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（v3）模式版本，因此不支持以后版本中引入的关键字。