feat: initial implementation of microprofile-openapi-3

Author: dcdh

CHANGELOG.md

@@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - support `<skipAbstractTypes>` flag to exclude abstract types (not interfaces)
 - support `<skipInterfaces>` flag to exclude interface types
 
+### `jsonschema-module-microprofile-openapi-3`
+#### Added
+***NOTE: `org.eclipse.microprofile.openapi:microprofile-openapi-api` minimum version is `3.1.1`!***
+- Initial implementation of `MicroProfileOpenApi3Module` for deriving schema attributes from MicroProfile OpenAPI 3 `@Schema` annotations.
+
 ## [4.36.0] - 2024-07-20
 ### `jsonschema-generator`
 #### Added

jsonschema-examples/pom.xml

@@ -64,6 +64,15 @@
             <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations</artifactId>
         </dependency>
+        <!-- Microprofile OpenAPI 3 Module dependencies -->
+        <dependency>
+            <groupId>com.github.victools</groupId>
+            <artifactId>jsonschema-module-microprofile-openapi-3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.microprofile.openapi</groupId>
+            <artifactId>microprofile-openapi-api</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.github.classgraph</groupId>
             <artifactId>classgraph</artifactId>

jsonschema-generator-bom/pom.xml

@@ -84,6 +84,11 @@
                 <artifactId>jsonschema-module-swagger-2</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.github.victools</groupId>
+                <artifactId>jsonschema-module-microprofile-openapi-3</artifactId>
+                <version>${project.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 

jsonschema-generator-parent/pom.xml

@@ -164,6 +164,7 @@
         <version.javax.validation>2.0.1.Final</version.javax.validation>
         <version.swagger-1.5>1.6.7</version.swagger-1.5>
         <version.swagger-2>2.2.5</version.swagger-2>
+        <version.microprofile-openapi-3>3.1.1</version.microprofile-openapi-3>
         <!-- maven plugin runtime dependencies -->
         <version.classgraph>4.8.149</version.classgraph>
     </properties>
@@ -212,6 +213,11 @@
                 <artifactId>classgraph</artifactId>
                 <version>${version.classgraph}</version>
             </dependency>
+            <dependency>
+                <groupId>org.eclipse.microprofile.openapi</groupId>
+                <artifactId>microprofile-openapi-api</artifactId>
+                <version>${version.microprofile-openapi-3}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <dependencies>

jsonschema-maven-plugin/README.md

@@ -187,12 +187,13 @@ When you want to have more control over the modules that are to be used during g
 ```
 This configuration will generate the schema using the Jackson module.
 
-There are five standard modules that can be used:
+There are six standard modules that can be used:
 - `Jackson`
 - `JakartaValidation`
 - `JavaxValidation`
 - `Swagger15` 
 - `Swagger2`
+- `MicroProfileOpenApi3`
 
 ### Defining options for a module
 ```xml

jsonschema-maven-plugin/pom.xml

@@ -129,6 +129,15 @@
             <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations</artifactId>
         </dependency>
+        <!-- Microprofile OpenAPI 3 Module dependencies -->
+        <dependency>
+            <groupId>com.github.victools</groupId>
+            <artifactId>jsonschema-module-microprofile-openapi-3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.microprofile.openapi</groupId>
+            <artifactId>microprofile-openapi-api</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

jsonschema-maven-plugin/src/main/java/com/github/victools/jsonschema/plugin/maven/SchemaGeneratorMojo.java

@@ -31,6 +31,7 @@
 import com.github.victools.jsonschema.module.jakarta.validation.JakartaValidationOption;
 import com.github.victools.jsonschema.module.javax.validation.JavaxValidationModule;
 import com.github.victools.jsonschema.module.javax.validation.JavaxValidationOption;
+import com.github.victools.jsonschema.module.microprofile.openapi3.MicroProfileOpenApi3Module;
 import com.github.victools.jsonschema.module.swagger15.SwaggerModule;
 import com.github.victools.jsonschema.module.swagger15.SwaggerOption;
 import com.github.victools.jsonschema.module.swagger2.Swagger2Module;
@@ -522,9 +523,14 @@ private void addStandardModule(GeneratorModule module, SchemaGeneratorConfigBuil
             this.getLog().debug("- Adding Swagger 2.x Module");
             configBuilder.with(new Swagger2Module());
             break;
+        case "MicroProfileOpenApi3":
+            this.getLog().debug("- Adding MicroProfile OpenAPI 3.x Module");
+            configBuilder.with(new MicroProfileOpenApi3Module());
+            break;
         default:
             throw new MojoExecutionException("Error: Module does not have a name in "
-                    + "['Jackson', 'JakartaValidation', 'JavaxValidation', 'Swagger15', 'Swagger2'] or does not have a custom classname.");
+                    + "['Jackson', 'JakartaValidation', 'JavaxValidation', 'Swagger15', 'Swagger2', 'MicroProfileOpenApi3']"
+                    + " or does not have a custom classname.");
         }
     }
 

jsonschema-maven-plugin/src/test/java/com/github/victools/jsonschema/plugin/maven/SchemaGeneratorMojoTest.java

@@ -57,6 +57,7 @@ public void setUp() throws Exception {
         "JakartaValidationModule",
         "Swagger15Module",
         "Swagger2Module",
+        "MicroProfileOpenApi3Module",
         "Complete"
     })
     public void testGeneration(String testCaseName) throws Exception {

jsonschema-maven-plugin/src/test/resources/reference-test-cases/MicroProfileOpenApi3Module-pom.xml

@@ -0,0 +1,19 @@
+<project>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>com.github.victools</groupId>
+                <artifactId>jsonschema-maven-plugin</artifactId>
+                <configuration>
+                    <classNames>com.github.victools.jsonschema.plugin.maven.TestClass</classNames>
+                    <schemaFilePath>target/generated-test-sources/MicroProfileOpenApi3Module</schemaFilePath>
+                    <modules>
+                        <module>
+                            <name>MicroProfileOpenApi3</name>
+                        </module>
+                    </modules>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

jsonschema-maven-plugin/src/test/resources/reference-test-cases/MicroProfileOpenApi3Module-reference.json

@@ -0,0 +1,9 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "type" : "object",
+  "properties" : {
+    "anInt" : {
+      "type" : "integer"
+    }
+  }
+}