JSON Schema হল 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" }
}
}
}
ব্যবহার ক্ষেত্র
- API ডকুমেন্টেশন (Swagger/OpenAPI ইন্টিগ্রেশন)
- ক্লায়েন্ট-সাইড ভ্যালিডেশন
- টেস্ট ডেটা জেনারেশন
- কন্ট্র্যাক্ট টেস্টিং (Consumer-Driven Contract)
ডিপেন্ডেন্সি
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-jsonSchema</artifactId>
<version>2.15.0</version>
</dependency>