JavaでJacksonを使用してJSONスキーマを生成する方法

JSON Schema（JSONスキーマ）は、JSONデータの構造を定義するための仕様です。JsonSchema クラスは、特定のアプリケーションがどのようなJSONデータを必要とし、それとどうやり取りすべきかという「契約（コントラクト）」を提供できます。また、JsonSchema を使うことで、JSONデータに対するバリデーション（検証）、ドキュメント化、ハイパーリンクナビゲーション、インタラクション制御などを定義することも可能です。

JSONスキーマを生成するには、JsonSchemaGenerator クラスの generateSchema() メソッドを使用します。このクラスは、JSONスキーマの生成機能をラップしたユーティリティです。

構文

public JsonSchema generateSchema(Class<T> type) throws com.fasterxml.jackson.databind.JsonMappingException

使用例

以下は、Person クラスと Address クラスからJSONスキーマを生成するサンプルコードです。

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 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 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;
    }
}

実行結果

上記のコードを実行すると、以下のようなJSONスキーマが出力されます。各フィールドの型が自動的に判定され、ネストされたオブジェクトや配列も正しく表現されていることがわかります。

{
    "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"
            }
        }
    }
}