JSON模式是基于JSON格式的规范,用于定义JSON数据的结构。该JsonSchema 类可以提供什么需要一个给定的应用程序以及如何与它进行交互JSON数据的合同。 JsonSchema 可以定义验证,文档,超链接导航和交互控制JSON数据。我们可以使用JsonSchemaGenerator的generateSchema()方法生成JSON模式,该类包装了JSON模式生成功能。
public JsonSchema generateSchema(Class<T> type) throws com.fasterxml.jackson.databind.JsonMappingException
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.module.jsonSchema.JsonSchema;
import com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator;
import java.util.List;
public class JSONSchemaTest {
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper jacksonObjectMapper = new ObjectMapper();
JsonSchemaGenerator schemaGen = new JsonSchemaGenerator(jacksonObjectMapper);
JsonSchema schema = schemaGen.generateSchema(Person.class);
String schemaString = jacksonObjectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(schema);
System.out.println(schemaString);
}
}
// Person class
class Person {
private String name;
private int age;
private List<String> courses;
private Address address;
public String getName() {
return name;
}
public int getAge(){
return age;
}
public List<String> getCourse() {
return courses;
}
public Address getAddress() {
return address;
}
}
// Address class
class Address {
private String firstLine;
private String secondLine;
private String thirdLine;
public String getFirstLine() {
return firstLine;
}
public String getSecondLine() {
return secondLine;
}
public String getThirdLine() {
return thirdLine;
}
}输出结果
{
"type" : "object",
"id" : "urn:jsonschema:Person",
"properties" : {
"name" : {
"type" : "string"
},
"age" : {
"type" : "integer"
},
"address" : {
"type" : "object",
"id" : "urn:jsonschema:Address",
"properties" : {
"firstLine" : {
"type" : "string"
},
"secondLine" : {
"type" : "string"
},
"thirdLine" : {
"type" : "string"
}
}
},
"course" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}