Schema Registry

json-schema-annotations/src/main/java/io/micronaut/jsonschema/GeneratedFromSchema.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2017-2024 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.jsonschema;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * An annotation that signals that the object was generated from json schema.
+ *
+ * @since 1.5.0
+ * @author Elif Kurtay
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE })
+public @interface GeneratedFromSchema {
+
+    /**
+     * The title of the JSON schema file used to generate the object.
+     *
+     * @return The fileName
+     */
+    String fileName() default "";
+
+}

json-schema-generator/src/main/java/io/micronaut/jsonschema/generator/SourceGenerator.java

@@ -18,6 +18,7 @@
 import io.micronaut.core.annotation.Internal;
 import io.micronaut.inject.processing.ProcessingException;
 import io.micronaut.inject.visitor.VisitorContext;
+import io.micronaut.jsonschema.GeneratedFromSchema;
 import io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator;
 import io.micronaut.jsonschema.generator.loaders.FileLoader;
 import io.micronaut.jsonschema.generator.utils.GeneratorContext;
@@ -303,7 +304,9 @@ private File generateFromSchema(Schema jsonSchema, Path outputPath, String packa
     public EnumDef buildEnum(Schema jsonSchema, String builderClassName) {
         EnumDef.EnumDefBuilder enumBuilder = EnumDef.builder(builderClassName)
             .addModifiers(Modifier.PUBLIC)
-            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
+            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN))
+            .addAnnotation(getGeneratedFromSchemaAnn());
+
         boolean isComplexEnum = false;
         LinkedHashMap<ExpressionDef.Constant, ExpressionDef> cases = new LinkedHashMap<>();
         LinkedHashMap<String, Object> enumValues = new LinkedHashMap<>();
@@ -378,7 +381,8 @@ public EnumDef buildEnum(Schema jsonSchema, String builderClassName) {
     private RecordDef buildRecord(Schema jsonSchema, String builderClassName) {
         RecordDef.RecordDefBuilder objectBuilder = RecordDef.builder(builderClassName)
             .addModifiers(Modifier.PUBLIC)
-            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
+            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN))
+            .addAnnotation(getGeneratedFromSchemaAnn());
 
         addFields(jsonSchema, objectBuilder);
         return objectBuilder.build();
@@ -387,7 +391,8 @@ private RecordDef buildRecord(Schema jsonSchema, String builderClassName) {
     private ClassDef buildClass(Schema jsonSchema, String builderClassName) {
         ClassDef.ClassDefBuilder objectBuilder = ClassDef.builder(builderClassName)
             .addModifiers(Modifier.PUBLIC)
-            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
+            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN))
+            .addAnnotation(getGeneratedFromSchemaAnn());
 
         if (context.hasDefinition(inputFileName + "/superClass")) {
             var superClass = context.getDefinitionType(inputFileName + "/superClass");
@@ -421,7 +426,8 @@ private ClassDef buildClass(Schema jsonSchema, String builderClassName) {
     private InterfaceDef buildInterface(Schema jsonSchema, String builderClassName) {
         InterfaceDef.InterfaceDefBuilder objectBuilder = InterfaceDef.builder(builderClassName)
             .addModifiers(Modifier.PUBLIC)
-            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN));
+            .addAnnotation(ClassTypeDef.of(SERDEABLE_ANN))
+            .addAnnotation(getGeneratedFromSchemaAnn());
         if (jsonSchema.hasDiscriminator()) {
             // top level interface
             addDiscriminatorAnnotations(jsonSchema, objectBuilder);
@@ -632,4 +638,8 @@ public static String getOutputPackageName() {
     public static VisitorContext.Language getLanguage() {
         return language;
     }
+
+    private static AnnotationDef getGeneratedFromSchemaAnn() {
+        return AnnotationDef.builder(ClassTypeDef.of(GeneratedFromSchema.class)).addMember("fileName", inputFileName).build();
+    }
 }

json-schema-generator/src/test/groovy/io/micronaut/jsonschema/generator/AbstractGeneratorSpec.groovy

@@ -16,6 +16,7 @@ class AbstractGeneratorSpec extends Specification {
 
     TypeDeclaration generateType(String className, String jsonSchema) {
         SourceGenerator generator = new SourceGenerator("java")
+        SourceGenerator.setInputFileName("test.schema.json")
 
         Path outputPath = new File("output").toPath() // Define the base output path
         String packageName = "com.example.project"; // Example package name

json-schema-generator/src/test/groovy/io/micronaut/jsonschema/generator/SimpleGeneratorSpec.groovy

@@ -27,6 +27,9 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public enum Status {
 
           ACTIVE("active"),
@@ -118,6 +121,9 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public record Llama(
             @NotNull @Min(0) int age,
             @NotNull @Size(min = 1) String name,
@@ -159,6 +165,9 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public record Llama(
             @Min(0) int age,
             Llama name,
@@ -207,20 +216,32 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public record Default(
             @Min(0) int age,
             Defaults defaults
         ) {
           @Serdeable
+          @GeneratedFromSchema(
+              fileName = "test.schema.json"
+          )
           public record Defaults(
               Run run
           ) {
             @Serdeable
+            @GeneratedFromSchema(
+                fileName = "test.schema.json"
+            )
             public record Run(
                 Shell shell,
                 @JsonProperty("working-directory") @Pattern(regexp = "^[a-zA-Z]*") String workingDirectory
             ) {
               @Serdeable
+              @GeneratedFromSchema(
+                  fileName = "test.schema.json"
+              )
               public enum Shell {
 
                 BASH("bash"),
@@ -296,6 +317,9 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public class Llama2 {
           /**
            * The age
@@ -395,6 +419,9 @@ class SimpleGeneratorSpec extends AbstractGeneratorSpec {
         then:
         content == """
         @Serdeable
+        @GeneratedFromSchema(
+            fileName = "test.schema.json"
+        )
         public record Llama3(
             @NotNull @Size(min = 1) String name,
             @NotNull String foo,

json-schema-registry/build.gradle

@@ -0,0 +1,50 @@
+import io.micronaut.build.internal.generator.BeanGeneratorTask
+
+plugins {
+    id("io.micronaut.build.internal.json-schema-module")
+    id("io.micronaut.build.internal.test-suite-generator-java")
+}
+
+dependencies {
+    compileOnly(mn.micronaut.core.processor)
+
+    implementation(projects.micronautJsonSchemaAnnotations)
+    implementation(mn.micronaut.http)
+    implementation(mn.micronaut.http.client)
+    implementation(mn.micronaut.jackson.databind)
+    implementation(mnSerde.micronaut.serde.jackson)
+    implementation(mnValidation.validation)
+
+    annotationProcessor(mn.micronaut.http.validation)
+    annotationProcessor(mnSerde.micronaut.serde.processor)
+
+    testAnnotationProcessor(mn.micronaut.inject.java)
+    testImplementation(mn.micronaut.inject)
+    testImplementation(mn.micronaut.http.server.netty)
+    testImplementation(mnTest.micronaut.test.junit5)
+    testImplementation(libs.junit.jupiter.api)
+    testRuntimeOnly(libs.junit.jupiter.engine)
+}
+
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+def animalGenerator = tasks.register("generateAnimals", BeanGeneratorTask) {
+    language = "java"
+    classpath.from(configurations.beanGenerator)
+    jsonFile.convention(layout.projectDirectory.file("src/test/resources/animal.schema.json"))
+    outputDirectory.convention(layout.buildDirectory.dir("generated/jsonSchema"))
+    packageName.convention("io.micronaut.jsonschema.generator.animals")
+}
+
+tasks.named("generateAnimals") {
+}
+
+sourceSets {
+    test {
+        java.srcDir('src/test/java')
+        java.srcDir(animalGenerator.map(BeanGeneratorTask::getGeneratedSourcesDirectory))
+    }
+}