openapi.json - add reading operationId from swagger @operation annotation (#573)

Author: rbygrave

http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java

@@ -22,6 +22,7 @@
 
 import io.avaje.http.generator.core.javadoc.Javadoc;
 import io.avaje.http.generator.core.openapi.MethodDocBuilder;
+import io.swagger.v3.oas.models.Operation;
 
 public class MethodReader {
 
@@ -269,6 +270,25 @@ private List<OpenAPIResponsePrism> buildApiResponses() {
     return responses;
   }
 
+  public void readOperation(Operation operation, Javadoc javadoc) {
+    OperationPrism.getOptionalOn(element).ifPresent(an -> {
+      operation.setOperationId(emptyToNull(an.operationId()));
+      operation.setDeprecated(an.deprecated());
+      operation.setSummary(emptyToNull(an.summary()));
+      operation.setDescription(emptyToNull(an.description()));
+    });
+    if (operation.getDescription() == null) {
+      operation.setDescription(javadoc.getDescription());
+    }
+    if (operation.getSummary() == null) {
+      operation.setSummary(javadoc.getSummary());
+    }
+  }
+
+  private static String emptyToNull(String val) {
+    return val.isEmpty() ? null : val;
+  }
+
   public <A> Optional<A> findAnnotation(Function<Element, Optional<A>> prismFunc) {
     return findAnnotation(prismFunc, element);
   }

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/MethodDocBuilder.java

@@ -39,9 +39,7 @@ public void build() {
       return;
     }
 
-    //operation.setOperationId();
-    operation.setSummary(javadoc.getSummary());
-    operation.setDescription(javadoc.getDescription());
+    methodReader.readOperation(operation, javadoc);
     operation.setTags(methodReader.tags());
 
     if (javadoc.isDeprecated()

http-generator-core/src/main/java/io/avaje/http/generator/core/package-info.java

@@ -23,6 +23,7 @@
 @GeneratePrism(value = io.avaje.http.api.InstrumentServerContext.class)
 @GeneratePrism(value = io.avaje.http.api.ExceptionHandler.class)
 @GeneratePrism(value = io.swagger.v3.oas.annotations.OpenAPIDefinition.class, publicAccess = true)
+@GeneratePrism(value = io.swagger.v3.oas.annotations.Operation.class, publicAccess = true)
 @GeneratePrism(value = io.swagger.v3.oas.annotations.tags.Tag.class, publicAccess = true)
 @GeneratePrism(value = io.swagger.v3.oas.annotations.tags.Tags.class, publicAccess = true)
 @GeneratePrism(value = io.swagger.v3.oas.annotations.security.SecurityScheme.class, publicAccess = true)

tests/test-javalin/src/main/java/org/example/myapp/web/HelloController.java

@@ -8,6 +8,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Executors;
 
+import io.swagger.v3.oas.annotations.Operation;
 import org.example.myapp.service.MyService;
 
 import io.avaje.http.api.BeanParam;
@@ -61,6 +62,7 @@ String getPlainMessage() {
    */
   @Deprecated
 @Roles({AppRoles.ADMIN, AppRoles.BASIC_USER})
+  @Operation(operationId = "helloByDate")
   @Get("/{id}/{date}")
   HelloDto hello(int id, LocalDate date, String otherParam) {
     return new HelloDto(id, date.toString(), otherParam);

tests/test-javalin/src/main/resources/public/openapi.json

@@ -750,6 +750,7 @@
 				],
 				"summary" : "Return the Hello DTO",
 				"description" : "",
+				"operationId" : "helloByDate",
 				"parameters" : [
 					{
 						"name" : "id",