use swagger APIResponse for more openAPI generation

Author: SentryMan

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

@@ -1,5 +1,17 @@
 package io.avaje.http.generator.core;
 
+import java.lang.annotation.Annotation;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.VariableElement;
+import javax.lang.model.type.ExecutableType;
+import javax.lang.model.type.TypeKind;
+import javax.lang.model.type.TypeMirror;
+import javax.validation.Valid;
+
 import io.avaje.http.api.Delete;
 import io.avaje.http.api.Form;
 import io.avaje.http.api.Get;
@@ -9,20 +21,10 @@
 import io.avaje.http.api.Put;
 import io.avaje.http.generator.core.javadoc.Javadoc;
 import io.avaje.http.generator.core.openapi.MethodDocBuilder;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import io.swagger.v3.oas.annotations.tags.Tags;
 
-import javax.lang.model.element.Element;
-import javax.lang.model.element.ExecutableElement;
-import javax.lang.model.element.VariableElement;
-import javax.lang.model.type.ExecutableType;
-import javax.lang.model.type.TypeKind;
-import javax.lang.model.type.TypeMirror;
-import javax.validation.Valid;
-import java.lang.annotation.Annotation;
-import java.util.ArrayList;
-import java.util.List;
-
 public class MethodReader {
 
   private final ProcessingContext ctx;
@@ -46,13 +48,19 @@ public class MethodReader {
 
   private final String produces;
 
+  private final ApiResponse[] apiResponses;
+
   private final ExecutableType actualExecutable;
   private final List<? extends TypeMirror> actualParams;
 
   private final PathSegments pathSegments;
   private final boolean hasValid;
 
-  MethodReader(ControllerReader bean, ExecutableElement element, ExecutableType actualExecutable, ProcessingContext ctx) {
+  MethodReader(
+      ControllerReader bean,
+      ExecutableElement element,
+      ExecutableType actualExecutable,
+      ProcessingContext ctx) {
     this.ctx = ctx;
     this.bean = bean;
     this.element = element;
@@ -62,6 +70,7 @@ public class MethodReader {
     this.methodRoles = Util.findRoles(element);
     this.javadoc = Javadoc.parse(ctx.getDocComment(element));
     this.produces = produces(bean);
+    this.apiResponses = getApiResponses();
     initWebMethodViaAnnotation();
     if (isWebMethod()) {
       this.hasValid = findAnnotation(Valid.class) != null;
@@ -122,6 +131,10 @@ private String produces(ControllerReader bean) {
     return (produces != null) ? produces.value() : bean.produces();
   }
 
+  private ApiResponse[] getApiResponses() {
+    return element.getAnnotationsByType(ApiResponse.class);
+  }
+
   public <A extends Annotation> A findAnnotation(Class<A> type) {
     A annotation = element.getAnnotation(type);
     if (annotation != null) {
@@ -216,6 +229,10 @@ public String produces() {
     return produces;
   }
 
+  public ApiResponse[] apiResponses() {
+    return apiResponses;
+  }
+
   public TypeMirror returnType() {
     if (actualExecutable != null) {
       return actualExecutable.getReturnType();

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

@@ -82,7 +82,22 @@ public void build() {
       String contentMediaType = (produces == null) ? MediaType.APPLICATION_JSON : produces;
       response.setContent(ctx.createContent(methodReader.returnType(), contentMediaType));
     }
-    responses.addApiResponse(methodReader.statusCode(), response);
+    var override2xx = false;
+    for (final var responseAnnotation : methodReader.apiResponses()) {
+      final var newResponse = new ApiResponse();
+
+      if (responseAnnotation.description().isEmpty())
+        newResponse.setDescription(response.getDescription());
+      else newResponse.setDescription(responseAnnotation.description());
+
+      // if user wants to define their own 2xx status code
+      if (responseAnnotation.responseCode().startsWith("2")) {
+        newResponse.setContent(response.getContent());
+        override2xx = true;
+      }
+      responses.addApiResponse(responseAnnotation.responseCode(), newResponse);
+    }
+    if (!override2xx) responses.addApiResponse(methodReader.statusCode(), response);
   }
 
   DocContext getContext() {