Added test suite for micronaut-openapi with spring-boot application. (#…

…1770) * Added test suite for micronaut-openapi with spring-boot application. Added documentation how to use micronaut-openapi with Spring applications * don’t define spring-boot version --------- Co-authored-by: Sergio del Amo <[email protected]>
micronaut-projects · Oct 3, 2024 · 14ca0fa · 14ca0fa
1 parent 47b9836
commit 14ca0fa
Show file tree

Hide file tree

Showing 26 changed files with 609 additions and 7 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -41,6 +41,7 @@ micronaut-kotlin = "4.4.0"
 micronaut-logging = "1.4.0"
 micronaut-session = "4.4.0"
 micronaut-grpc = "4.7.1"
+micronaut-spring = "5.8.0"
 micronaut-docs = "2.0.0"
 
 [libraries]
@@ -73,6 +74,7 @@ micronaut-data = { module = "io.micronaut.data:micronaut-data-bom", version.ref
 micronaut-test = { module = "io.micronaut.test:micronaut-test-bom", version.ref = "micronaut-test" }
 micronaut-kotlin = { module = "io.micronaut.kotlin:micronaut-kotlin-bom", version.ref = "micronaut-kotlin" }
 micronaut-grpc = { module = "io.micronaut.grpc:micronaut-grpc-bom", version.ref = "micronaut-grpc" }
+micronaut-spring = { module = "io.micronaut.spring:micronaut-spring-bom", version.ref = "micronaut-spring" }
 micronaut-platform = { module = "io.micronaut.platform:micronaut-platform", version.ref = "micronaut-platform"}
 micronaut-gradle-plugin = { module = "io.micronaut.gradle:micronaut-minimal-plugin", version.ref = "micronaut-gradle-plugin"}
 
@@ -88,7 +90,10 @@ commons-lang3 = { module = "org.apache.commons:commons-lang3", version.ref = "co
 commons-text = { module = "org.apache.commons:commons-text", version.ref = "commons-text" }
 guava = { module = "com.google.guava:guava", version.ref = "guava" }
 commonmark = { module = "org.commonmark:commonmark", version.ref = "commonmark" }
-
+spring-boot-starter-web = { module = "org.springframework.boot:spring-boot-starter-web" }
+spring-boot-starter-validation = { module = "org.springframework.boot:spring-boot-starter-validation" }
+spring-boot-starter-data-rest = { module = "org.springframework.boot:spring-boot-starter-data-rest" }
+spring-boot-starter-test = { module = "org.springframework.boot:spring-boot-starter-test" }
 openapi-generator = { module = "org.openapitools:openapi-generator", version.ref = "openapi-generator" }
 swagger-parser = { module = "io.swagger:swagger-parser", version.ref = "swagger-parser" }
 swagger-parser-v3 = { module = "io.swagger.parser.v3:swagger-parser-v3", version.ref = "swagger-parser-v3" }

diff --git a/openapi/src/main/java/io/micronaut/openapi/visitor/ElementUtils.java b/openapi/src/main/java/io/micronaut/openapi/visitor/ElementUtils.java
@@ -27,6 +27,7 @@
 import io.micronaut.http.HttpRequest;
 import io.micronaut.http.HttpResponse;
 import io.micronaut.http.annotation.Header;
+import io.micronaut.http.annotation.RequestAttribute;
 import io.micronaut.http.multipart.FileUpload;
 import io.micronaut.inject.annotation.AnnotationMetadataHierarchy;
 import io.micronaut.inject.ast.ClassElement;
@@ -246,8 +247,10 @@ public static boolean isIgnoredParameter(TypedElement parameter) {
             || parameter.isAnnotationPresent(Hidden.class)
             || parameter.isAnnotationPresent(JsonIgnore.class)
             || parameter.isAnnotationPresent(Header.class) && parameter.getType().isAssignable(Map.class)
+            || parameter.isAnnotationPresent(RequestAttribute.class)
             || parameter.booleanValue(Parameter.class, PROP_HIDDEN).orElse(false)
             || parameter.hasAnnotation("io.micronaut.session.annotation.SessionValue")
+            || parameter.hasAnnotation("org.springframework.web.bind.annotation.RequestAttribute")
             || parameter.hasAnnotation("org.springframework.web.bind.annotation.SessionAttribute")
             || parameter.hasAnnotation("org.springframework.web.bind.annotation.SessionAttributes")
             || parameter.hasAnnotation("jakarta.ws.rs.core.Context")

diff --git a/openapi/src/main/java/io/micronaut/openapi/visitor/SchemaDefinitionUtils.java b/openapi/src/main/java/io/micronaut/openapi/visitor/SchemaDefinitionUtils.java
@@ -2481,10 +2481,10 @@ private static void processPropertyElements(OpenAPI openAPI, VisitorContext cont
 
             if (publicField instanceof MemberElement memberEl && (memberEl.getDeclaringType().getType().getName().equals(type.getName()) || isGetterOverridden)) {
 
-                ClassElement fieldType = publicField.getGenericType();
                 if (withJsonView && !allowedByJsonView(publicField, classLvlJsonViewClasses, jsonViewClass, context)) {
                     continue;
                 }
+                ClassElement fieldType = publicField.getGenericType();
 
                 Schema<?> propertySchema = resolveSchema(openAPI, publicField, fieldType, context, mediaTypes, jsonViewClass, fieldJavadoc, classJavadoc);
 

diff --git a/settings.gradle b/settings.gradle
@@ -24,6 +24,7 @@ include 'docs-examples:example-java'
 include 'docs-examples:example-kotlin'
 include 'test-suite-java-client-generator'
 include 'test-suite-java-jaxrs'
+include 'test-suite-java-spring'
 include 'test-suite-java-server-generator'
 include 'test-suite-kotlin-kapt-client-generator'
 include 'test-suite-kotlin-kapt-server-generator'
@@ -52,4 +53,5 @@ micronautBuild {
     importMicronautCatalog("micronaut-session")
     importMicronautCatalog("micronaut-jaxrs")
     importMicronautCatalog("micronaut-grpc")
+    importMicronautCatalog("micronaut-spring")
 }
diff --git a/src/main/docs/guide/spring.adoc b/src/main/docs/guide/spring.adoc
@@ -0,0 +1 @@
+You can use `micronaut-openapi` to build openapi specification for `Spring` / `Spring Boot` applications. In this case, you do not need to change anything in the code. You can continue to use spring, and use micronaut as a replacement for such libraries as `springdoc-openapi`, `springfox`, `swagger` etc.
diff --git a/src/main/docs/guide/spring/springWithGradle.adoc b/src/main/docs/guide/spring/springWithGradle.adoc
@@ -0,0 +1,24 @@
+To use micronaut-openapi with spring in gradle add this code to you `build.gradle`:
+
+.build.gradle
+[source,groovy]
+----
+dependencies {
+
+    // add to annotationProcessor and compileOnly blocks next libraries:
+
+    annotationProcessor("io.micronaut:micronaut-inject-java:$micronautCoreVersion")
+    annotationProcessor(platfom("io.micronaut.spring:micronaut-spring-bom:$micronautSpringVersion"))
+    annotationProcessor("io.micronaut.spring:micronaut-spring-annotation")
+    annotationProcessor("io.micronaut.spring:micronaut-spring-web-annotation")
+    annotationProcessor("io.micronaut.spring:micronaut-spring-boot-annotation")
+    annotationProcessor("io.micronaut.openapi:micronaut-openapi:$micronautOpenapiVersion")
+
+    compileOnly("io.micronaut:micronaut-inject-java:$micronautCoreVersion")
+    compileOnly("io.micronaut.openapi:micronaut-openapi-annotations:$micronautOpenapiVersion")
+    compileOnly("io.micronaut.serde:micronaut-serde-api:$micronautSerdeVersion")
+
+}
+----
+
+For kotlin just change block `annotationProcessor` to `kapt` or `ksp`.
diff --git a/src/main/docs/guide/spring/springWithMaven.adoc b/src/main/docs/guide/spring/springWithMaven.adoc
@@ -0,0 +1,131 @@
+To use micronaut-openapi with spring in maven add this code to your `pom.xml`
+
+.pom.xml
+[source,xml]
+----
+    <dependencies>
+        <dependency>
+            <groupId>io.micronaut</groupId>
+            <artifactId>micronaut-inject-java</artifactId>
+            <version>${micronaut.core.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.openapi</groupId>
+            <artifactId>micronaut-openapi-annotations</artifactId>
+            <version>${micronaut.openapi.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.serde</groupId>
+            <artifactId>micronaut-serde-api</artifactId>
+            <version>${micronaut.serde.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths combine.children="append">
+                        <path>
+                            <groupId>io.micronaut</groupId>
+                            <artifactId>micronaut-inject-java</artifactId>
+                            <version>${micronaut.core.version}</version>
+                        </path>
+                        <path>
+                            <groupId>io.micronaut.spring</groupId>
+                            <artifactId>micronaut-spring-annotation</artifactId>
+                            <version>${micronaut.spring.version}</version>
+                        </path>
+                        <path>
+                            <groupId>io.micronaut.spring</groupId>
+                            <artifactId>micronaut-spring-web-annotation</artifactId>
+                            <version>${micronaut.spring.version}</version>
+                        </path>
+                        <path>
+                            <groupId>io.micronaut.spring</groupId>
+                            <artifactId>micronaut-spring-boot-annotation</artifactId>
+                            <version>${micronaut.spring.version}</version>
+                        </path>
+                        <path>
+                            <groupId>io.micronaut.openapi</groupId>
+                            <artifactId>micronaut-openapi</artifactId>
+                            <version>${micronaut.openapi.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+----
+
+For kotlin
+.pom.xml
+[source,xml]
+----
+    <dependencies>
+        <dependency>
+            <groupId>io.micronaut</groupId>
+            <artifactId>micronaut-inject-java</artifactId>
+            <version>${micronaut.core.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.openapi</groupId>
+            <artifactId>micronaut-openapi-annotations</artifactId>
+            <version>${micronaut.openapi.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.micronaut.serde</groupId>
+            <artifactId>micronaut-serde-api</artifactId>
+            <version>${micronaut.serde.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <executions>
+        <execution>
+            <id>kapt</id>
+            <goals>
+                <goal>kapt</goal>
+            </goals>
+            <configuration>
+                <sourceDirs>
+                    <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
+                </sourceDirs>
+                <annotationProcessorPaths combine.self="override">
+                    <annotationProcessorPath>
+                        <groupId>io.micronaut</groupId>
+                        <artifactId>micronaut-inject-java</artifactId>
+                        <version>${micronaut.core.version}</version>
+                    </annotationProcessorPath>
+                    <annotationProcessorPath>
+                        <groupId>io.micronaut.spring</groupId>
+                        <artifactId>micronaut-spring-annotation</artifactId>
+                        <version>${micronaut.spring.version}</version>
+                    </annotationProcessorPath>
+                    <annotationProcessorPath>
+                        <groupId>io.micronaut.spring</groupId>
+                        <artifactId>micronaut-spring-web-annotation</artifactId>
+                        <version>${micronaut.spring.version}</version>
+                    </annotationProcessorPath>
+                    <annotationProcessorPath>
+                        <groupId>io.micronaut.spring</groupId>
+                        <artifactId>micronaut-spring-boot-annotation</artifactId>
+                        <version>${micronaut.spring.version}</version>
+                    </annotationProcessorPath>
+                    <annotationProcessorPath>
+                        <groupId>io.micronaut.openapi</groupId>
+                        <artifactId>micronaut-openapi</artifactId>
+                        <version>${micronaut.openapi.version}</version>
+                    </annotationProcessorPath>
+                </annotationProcessorPaths>
+           </configuration>
+        </execution>
+    </executions>
+----
diff --git a/src/main/docs/guide/spring/springWithOpenApiView.adoc b/src/main/docs/guide/spring/springWithOpenApiView.adoc
@@ -0,0 +1,4 @@
+To use micronaut openapi views (Swagger UI, OpenAPi Explorer, Redoc, RapiDoc) you need to add static resources to Spring configuration like this:
+
+.Example Swagger UI resources routing config
+snippet::io.micronaut.openapi.spring.WebConfig[tags="imports,clazz", project-base="test-suite-java-spring"]
diff --git a/src/main/docs/guide/toc.yml b/src/main/docs/guide/toc.yml
@@ -63,6 +63,10 @@ serverContext:
   compileResolution: Compile Time Resolution
   serverFilter: HttpServerFilter
   urlParameter: URL Parameter
+spring:
+  title: Micronaut OpenAPI with Spring
+  springWithGradle: Spring with Gradle
+  springWithMaven: Spring with Maven
 openApiGuides: Guides
 repository: Repository
 breaks: Breaking Changes
diff --git a/.../io/micronaut/open/jaxrs/Application.java → .../micronaut/openapi/jaxrs/Application.java b/.../io/micronaut/open/jaxrs/Application.java → .../micronaut/openapi/jaxrs/Application.java
@@ -1,4 +1,4 @@
-package io.micronaut.open.jaxrs;
+package io.micronaut.openapi.jaxrs;
 
 import io.micronaut.runtime.Micronaut;
 import io.swagger.v3.oas.annotations.OpenAPIDefinition;

diff --git a/...ronaut/open/jaxrs/OpenApiExposedTest.java → ...aut/openapi/jaxrs/OpenApiExposedTest.java b/...ronaut/open/jaxrs/OpenApiExposedTest.java → ...aut/openapi/jaxrs/OpenApiExposedTest.java
@@ -1,4 +1,4 @@
-package io.micronaut.open.jaxrs;
+package io.micronaut.openapi.jaxrs;
 
 import io.micronaut.http.client.BlockingHttpClient;
 import io.micronaut.http.client.HttpClient;

diff --git a/...naut/open/jaxrs/OpenApiGeneratedTest.java → ...t/openapi/jaxrs/OpenApiGeneratedTest.java b/...naut/open/jaxrs/OpenApiGeneratedTest.java → ...t/openapi/jaxrs/OpenApiGeneratedTest.java
@@ -1,4 +1,4 @@
-package io.micronaut.open.jaxrs;
+package io.micronaut.openapi.jaxrs;
 
 import io.micronaut.core.io.ResourceLoader;
 import io.micronaut.test.extensions.junit5.annotation.MicronautTest;

diff --git a/.../micronaut/open/jaxrs/TestController.java → ...cronaut/openapi/jaxrs/TestController.java b/.../micronaut/open/jaxrs/TestController.java → ...cronaut/openapi/jaxrs/TestController.java
@@ -1,4 +1,4 @@
-package io.micronaut.open.jaxrs;
+package io.micronaut.openapi.jaxrs;
 
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;

diff --git a/...ronaut/open/jaxrs/TestControllerTest.java → ...aut/openapi/jaxrs/TestControllerTest.java b/...ronaut/open/jaxrs/TestControllerTest.java → ...aut/openapi/jaxrs/TestControllerTest.java
@@ -1,4 +1,4 @@
-package io.micronaut.open.jaxrs;
+package io.micronaut.openapi.jaxrs;
 
 import io.micronaut.http.client.BlockingHttpClient;
 import io.micronaut.http.client.HttpClient;

diff --git a/test-suite-java-spring/build.gradle b/test-suite-java-spring/build.gradle
@@ -0,0 +1,54 @@
+plugins {
+    id("io.micronaut.build.internal.openapi-test-java")
+}
+
+sourceSets {
+    test {
+        java {
+            srcDirs += "$buildDir/classes/java"
+        }
+    }
+}
+
+dependencies {
+
+    annotationProcessor(mnSpring.micronaut.spring.annotation)
+    annotationProcessor(mnSpring.micronaut.spring.web.annotation)
+    annotationProcessor(mnSpring.micronaut.spring.boot.annotation)
+    annotationProcessor(mn.micronaut.inject.java)
+    annotationProcessor(projects.micronautOpenapi)
+
+    compileOnly(projects.micronautOpenapiAnnotations)
+    compileOnly(mn.jackson.annotations)
+    compileOnly(mn.micronaut.inject.java)
+    compileOnly(mnSerde.micronaut.serde.api)
+
+    implementation(platform("org.springframework.boot:spring-boot-dependencies:${mnSpring.versions.spring.boot.get()}"))
+    implementation(libs.spring.boot.starter.web)
+    implementation(libs.spring.boot.starter.validation)
+    implementation(libs.spring.boot.starter.data.rest)
+
+    testCompileOnly(projects.micronautOpenapiAnnotations)
+    testCompileOnly(mn.jackson.annotations)
+    testCompileOnly(mn.micronaut.inject.java)
+    testCompileOnly(mnSerde.micronaut.serde.api)
+
+    testImplementation("org.springframework.boot:spring-boot-dependencies:${mnSpring.versions.spring.boot.get()}" )
+    testImplementation(libs.spring.boot.starter.test)
+    testImplementation(mnTest.junit.jupiter.api)
+    testImplementation(projects.micronautOpenapiCommon)
+
+    testRuntimeOnly(mnLogging.logback.classic)
+    testRuntimeOnly(mnTest.junit.jupiter.engine)
+}
+
+tasks.withType(JavaCompile).configureEach {
+    options.encoding = "UTF-8"
+    options.incremental = true
+    options.fork = true
+    options.compilerArgs = [
+        '-parameters',
+        '-Xlint:unchecked',
+        '-Xlint:deprecation'
+    ]
+}
diff --git a/test-suite-java-spring/openapi.properties b/test-suite-java-spring/openapi.properties
@@ -0,0 +1 @@
+micronaut.openapi.views.spec=swagger-ui.enabled=true
diff --git a/test-suite-java-spring/src/main/java/io/micronaut/openapi/spring/Application.java b/test-suite-java-spring/src/main/java/io/micronaut/openapi/spring/Application.java
@@ -0,0 +1,23 @@
+package io.micronaut.openapi.spring;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.info.Info;
+import org.springframework.boot.Banner;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+@OpenAPIDefinition(
+    info = @Info(
+        title = "demo",
+        version = "0.0"
+    )
+)
+public class Application {
+
+    public static void main(String[] args) {
+        var application = new SpringApplication(Application.class);
+        application.setBannerMode(Banner.Mode.OFF);
+        application.run(args);
+    }
+}
diff --git a/test-suite-java-spring/src/main/java/io/micronaut/openapi/spring/WebConfig.java b/test-suite-java-spring/src/main/java/io/micronaut/openapi/spring/WebConfig.java
@@ -0,0 +1,22 @@
+package io.micronaut.openapi.spring;
+// tag::imports[]
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+// end::imports[]
+// tag::clazz[]
+@Configuration
+@EnableWebMvc
+public class WebConfig implements WebMvcConfigurer {
+
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("/swagger-ui/**")
+            .addResourceLocations("classpath:/META-INF/swagger/views/swagger-ui/");
+        registry.addResourceHandler("/swagger/**")
+            .addResourceLocations("classpath:/META-INF/swagger/");
+    }
+}
+//end::clazz[]