Java JSON Schema Generator 技术文档

Java JSON Schema Generator 技术文档

安装指南

依赖配置 (Maven)

要在Maven项目中使用Java JSON Schema Generator，请在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>com.github.victools</groupId>
    <artifactId>jsonschema-generator</artifactId>
    <version>4.36.0</version>
</dependency>

建议使用相同版本的jsonschema-generator和jsonschema-module-*依赖，以确保兼容性。不建议使用低于jsonschema-module-*依赖版本的jsonschema-generator，否则可能会导致运行时错误。

项目的使用说明

代码示例

以下是一个完整的代码示例，展示了如何使用Java JSON Schema Generator生成JSON Schema：

import com.fasterxml.jackson.databind.JsonNode;
import com.github.victools.jsonschema.generator.OptionPreset;
import com.github.victools.jsonschema.generator.SchemaGenerator;
import com.github.victools.jsonschema.generator.SchemaGeneratorConfig;
import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
import com.github.victools.jsonschema.generator.SchemaVersion;

public class JsonSchemaExample {
    public static void main(String[] args) {
        SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2020_12, OptionPreset.PLAIN_JSON);
        SchemaGeneratorConfig config = configBuilder.build();
        SchemaGenerator generator = new SchemaGenerator(config);
        JsonNode jsonSchema = generator.generateSchema(YourClass.class);

        System.out.println(jsonSchema.toPrettyString());
    }
}

其他示例

更多示例可以在项目的jsonschema-examples文件夹或测试类中找到。

项目API使用文档

SchemaGeneratorConfigBuilder

SchemaGeneratorConfigBuilder用于构建生成器配置。可以通过以下方式创建：

SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2020_12, OptionPreset.PLAIN_JSON);

SchemaGeneratorConfig

SchemaGeneratorConfig是生成器的配置对象，通过SchemaGeneratorConfigBuilder构建：

SchemaGeneratorConfig config = configBuilder.build();

SchemaGenerator

SchemaGenerator是实际生成JSON Schema的类：

SchemaGenerator generator = new SchemaGenerator(config);

生成JSON Schema

使用SchemaGenerator生成JSON Schema：

JsonNode jsonSchema = generator.generateSchema(YourClass.class);

项目安装方式

Maven安装

通过Maven安装Java JSON Schema Generator，只需在pom.xml中添加依赖：

<dependency>
    <groupId>com.github.victools</groupId>
    <artifactId>jsonschema-generator</artifactId>
    <version>4.36.0</version>
</dependency>

手动安装

如果需要手动安装，可以从Maven Central下载JAR文件，并将其添加到项目的类路径中。

通过以上步骤，您可以成功安装并使用Java JSON Schema Generator来生成JSON Schema。