Resolve some warnings in Spring extension

Signed-off-by: Michael Edgar <[email protected]>
smallrye · Nov 16, 2024 · ef7c308 · ef7c308
1 parent 72c1c1c
commit ef7c308
Show file tree

Hide file tree

Showing 12 changed files with 67 additions and 55 deletions.
diff --git a/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringAnnotationScanner.java b/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringAnnotationScanner.java
@@ -4,7 +4,6 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
-import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
@@ -229,51 +228,14 @@ private void processControllerMethods(final ClassInfo resourceClass,
 
         for (MethodInfo methodInfo : getResourceMethods(context, resourceClass)) {
             if (!methodInfo.annotations().isEmpty()) {
-                for (PathItem.HttpMethod httpMethod : getHttpMethods(methodInfo)) {
+                for (PathItem.HttpMethod httpMethod : SpringSupport.getHttpMethods(methodInfo)) {
                     processControllerMethod(resourceClass, methodInfo, httpMethod, openApi, tagRefs,
                             locatorPathParameters);
                 }
             }
         }
     }
 
-    static Set<PathItem.HttpMethod> getHttpMethods(MethodInfo methodInfo) {
-        Set<PathItem.HttpMethod> methods = new LinkedHashSet<>();
-
-        // Try @XXXMapping annotations
-        for (DotName validMethodAnnotations : SpringConstants.HTTP_METHODS) {
-            if (methodInfo.hasAnnotation(validMethodAnnotations)) {
-                String toHttpMethod = toHttpMethod(validMethodAnnotations);
-                methods.add(PathItem.HttpMethod.valueOf(toHttpMethod));
-            }
-        }
-
-        // Try @RequestMapping
-        if (methodInfo.hasAnnotation(SpringConstants.REQUEST_MAPPING)) {
-            AnnotationInstance requestMappingAnnotation = methodInfo.annotation(SpringConstants.REQUEST_MAPPING);
-            AnnotationValue methodValue = requestMappingAnnotation.value("method");
-
-            if (methodValue != null) {
-                String[] enumArray = methodValue.asEnumArray();
-                for (String enumValue : enumArray) {
-                    if (enumValue != null) {
-                        methods.add(PathItem.HttpMethod.valueOf(enumValue.toUpperCase()));
-                    }
-                }
-            } else {
-                // Default ?
-            }
-        }
-
-        return methods;
-    }
-
-    private static String toHttpMethod(DotName dotname) {
-        String className = dotname.withoutPackagePrefix();
-        className = className.replace("Mapping", "");
-        return className.toUpperCase();
-    }
-
     /**
      * Process a single Spring method to produce an OpenAPI Operation.
      *

diff --git a/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringParameterProcessor.java b/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringParameterProcessor.java
@@ -151,7 +151,7 @@ static boolean annotatesHttpGET(AnnotationTarget target) {
         MethodInfo resourceMethod = targetMethod(target);
 
         if (resourceMethod != null) {
-            return SpringAnnotationScanner.getHttpMethods(resourceMethod).contains(PathItem.HttpMethod.GET);
+            return SpringSupport.getHttpMethods(resourceMethod).contains(PathItem.HttpMethod.GET);
         }
 
         return false;

diff --git a/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringSupport.java b/extension-spring/src/main/java/io/smallrye/openapi/spring/SpringSupport.java
@@ -0,0 +1,53 @@
+package io.smallrye.openapi.spring;
+
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+import org.eclipse.microprofile.openapi.models.PathItem;
+import org.jboss.jandex.AnnotationInstance;
+import org.jboss.jandex.AnnotationValue;
+import org.jboss.jandex.DotName;
+import org.jboss.jandex.MethodInfo;
+
+class SpringSupport {
+
+    private SpringSupport() {
+    }
+
+    static Set<PathItem.HttpMethod> getHttpMethods(MethodInfo methodInfo) {
+        Set<PathItem.HttpMethod> methods = new LinkedHashSet<>();
+
+        // Try @XXXMapping annotations
+        for (DotName validMethodAnnotations : SpringConstants.HTTP_METHODS) {
+            if (methodInfo.hasAnnotation(validMethodAnnotations)) {
+                String toHttpMethod = toHttpMethod(validMethodAnnotations);
+                methods.add(PathItem.HttpMethod.valueOf(toHttpMethod));
+            }
+        }
+
+        // Try @RequestMapping
+        if (methodInfo.hasAnnotation(SpringConstants.REQUEST_MAPPING)) {
+            AnnotationInstance requestMappingAnnotation = methodInfo.annotation(SpringConstants.REQUEST_MAPPING);
+            AnnotationValue methodValue = requestMappingAnnotation.value("method");
+
+            if (methodValue != null) {
+                String[] enumArray = methodValue.asEnumArray();
+                for (String enumValue : enumArray) {
+                    if (enumValue != null) {
+                        methods.add(PathItem.HttpMethod.valueOf(enumValue.toUpperCase()));
+                    }
+                }
+            } else {
+                // Default ?
+            }
+        }
+
+        return methods;
+    }
+
+    private static String toHttpMethod(DotName dotname) {
+        String className = dotname.withoutPackagePrefix();
+        className = className.replace("Mapping", "");
+        return className.toUpperCase();
+    }
+}
diff --git a/...spring/src/test/java/io/smallrye/openapi/runtime/scanner/SpringAnnotationScannerTest.java b/...spring/src/test/java/io/smallrye/openapi/runtime/scanner/SpringAnnotationScannerTest.java
@@ -15,10 +15,9 @@
 import test.io.smallrye.openapi.runtime.scanner.resources.GreetingGetControllerAlt;
 import test.io.smallrye.openapi.runtime.scanner.resources.GreetingGetControllerAlt2;
 import test.io.smallrye.openapi.runtime.scanner.resources.GreetingPostController;
+import test.io.smallrye.openapi.runtime.scanner.resources.GreetingPostControllerAlt;
 import test.io.smallrye.openapi.runtime.scanner.resources.GreetingPutController;
 import test.io.smallrye.openapi.runtime.scanner.resources.GreetingPutControllerAlt;
-import test.io.smallrye.openapi.runtime.scanner.resources.javax.GreetingPostControllerWithServletContext;
-import test.io.smallrye.openapi.runtime.scanner.resources.javax.GreetingPutControllerWithServletContext;
 
 /**
  * Basic Spring annotation scanning
@@ -107,7 +106,7 @@ void testBasicPostSpringDefinitionScanning() throws IOException, JSONException {
      */
     @Test
     void testBasicPostSpringDefinitionScanningAlt() throws IOException, JSONException {
-        Index i = indexOf(GreetingPostController.class, Greeting.class, GreetingParam.class);
+        Index i = indexOf(GreetingPostControllerAlt.class, Greeting.class, GreetingParam.class);
         OpenApiAnnotationScanner scanner = new OpenApiAnnotationScanner(emptyConfig(), i);
 
         OpenAPI result = scanner.scan();

diff --git a/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingDeleteController.java b/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingDeleteController.java
@@ -22,13 +22,13 @@ public class GreetingDeleteController {
     // 1) Basic path var test
     @DeleteMapping("/greet/{id}")
     public void greet(@PathVariable(name = "id") String id) {
-
+        // No op
     }
 
     // 2) ResponseEntity without a type specified
     @DeleteMapping("/greetWithResponse/{id}")
     @APIResponse(responseCode = "204", description = "No Content")
-    public ResponseEntity greetWithResponse(@PathVariable(name = "id") String id) {
+    public ResponseEntity<Void> greetWithResponse(@PathVariable(name = "id") String id) {
         return ResponseEntity.noContent().build();
     }
 

diff --git a/.../java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingDeleteControllerAlt.java b/.../java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingDeleteControllerAlt.java
@@ -22,13 +22,13 @@ public class GreetingDeleteControllerAlt {
     // 1) Basic path var test
     @RequestMapping(value = "/greet/{id}", method = RequestMethod.DELETE)
     public void greet(@PathVariable(name = "id") String id) {
-
+        // No op
     }
 
     // 2) ResponseEntity without a type specified
     @RequestMapping(value = "/greetWithResponse/{id}", method = RequestMethod.DELETE)
     @APIResponse(responseCode = "204", description = "No Content")
-    public ResponseEntity greetWithResponse(@PathVariable(name = "id") String id) {
+    public ResponseEntity<Void> greetWithResponse(@PathVariable(name = "id") String id) {
         return ResponseEntity.noContent().build();
     }
 

diff --git a/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingGetControllerAlt.java b/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingGetControllerAlt.java
@@ -10,7 +10,6 @@
 import org.springdoc.api.annotations.ParameterObject;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -66,7 +65,7 @@ public Greeting helloParameterObject(@ParameterObject() GreetingParam params) {
     // 5) ResponseEntity without a type specified
     @RequestMapping(value = "/helloPathVariableWithResponse/{name}", method = RequestMethod.GET)
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity helloPathVariableWithResponse(@PathVariable(name = "name") String name) {
+    public ResponseEntity<Greeting> helloPathVariableWithResponse(@PathVariable(name = "name") String name) {
         return ResponseEntity.ok(new Greeting("Hello " + name));
     }
 

diff --git a/...st/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingGetControllerAlt2.java b/...st/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingGetControllerAlt2.java
@@ -10,7 +10,6 @@
 import org.springdoc.api.annotations.ParameterObject;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -66,7 +65,7 @@ public Greeting helloParameterObject(@ParameterObject() GreetingParam params) {
     // 5) ResponseEntity without a type specified
     @RequestMapping(path = "/helloPathVariableWithResponse/{name}", method = RequestMethod.GET)
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity helloPathVariableWithResponse(@PathVariable(name = "name") String name) {
+    public ResponseEntity<Greeting> helloPathVariableWithResponse(@PathVariable(name = "name") String name) {
         return ResponseEntity.ok(new Greeting("Hello " + name));
     }
 

diff --git a/.../test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPostController.java b/.../test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPostController.java
@@ -32,7 +32,7 @@ public Greeting greet(@RequestBody Greeting greeting) {
     // 2) ResponseEntity without a type specified
     @PostMapping("/greetWithResponse")
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity greetWithResponse(@RequestBody Greeting greeting) {
+    public ResponseEntity<Greeting> greetWithResponse(@RequestBody Greeting greeting) {
         return ResponseEntity.ok(greeting);
     }
 

diff --git a/...st/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPostControllerAlt.java b/...st/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPostControllerAlt.java
@@ -34,7 +34,7 @@ public Greeting greet(@RequestBody Greeting greeting) {
     // 2) ResponseEntity without a type specified
     @RequestMapping(value = "/greetWithResponse", method = RequestMethod.POST)
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity greetWithResponse(@RequestBody Greeting greeting) {
+    public ResponseEntity<Greeting> greetWithResponse(@RequestBody Greeting greeting) {
         return ResponseEntity.ok(greeting);
     }
 

diff --git a/...c/test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPutController.java b/...c/test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPutController.java
@@ -33,7 +33,7 @@ public Greeting greet(@RequestBody Greeting greeting, @PathVariable(name = "id")
     // 2) ResponseEntity without a type specified
     @PutMapping("/greetWithResponse/{id}")
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity greetWithResponse(@RequestBody Greeting greeting, @PathVariable(name = "id") String id) {
+    public ResponseEntity<Greeting> greetWithResponse(@RequestBody Greeting greeting, @PathVariable(name = "id") String id) {
         return ResponseEntity.ok(greeting);
     }
 

diff --git a/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPutControllerAlt.java b/...est/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPutControllerAlt.java
@@ -33,7 +33,7 @@ public Greeting greet(@RequestBody Greeting greeting, @PathVariable(name = "id")
     // 2) ResponseEntity without a type specified
     @RequestMapping(value = "/greetWithResponse/{id}", method = RequestMethod.PUT)
     @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
-    public ResponseEntity greetWithResponse(@RequestBody Greeting greeting, @PathVariable(name = "id") String id) {
+    public ResponseEntity<Greeting> greetWithResponse(@RequestBody Greeting greeting, @PathVariable(name = "id") String id) {
         return ResponseEntity.ok(greeting);
     }